Configure Telemetry Service

Learn how to configure Telemetry Service.

Related documentation:

• Suite-level guide
• All services
• Telemetry Service Release Notes

RSS:

• For private edition

Configure a secret to access JFrog

If you haven't done so already, create a secret for accessing the JFrog registry:

kubectl create secret docker-registry <credential-name> --docker-server=<docker repo> --docker-username=<username> --docker-password=<password> --docker-email=<emailid>

Now map the secret to the default service account:

kubectl secrets link default <credential-name> --for=pull

Override Helm chart values

Parameter	Description	Default	Valid values
`TELEMETRY_SERVICES_AUTH`	URL of the GWS Auth public API. This is a mandatory field.		http://gws-core-auth:8095
`TELEMETRY_AUTH_CLIENT_ID`	The Client ID that is used to authenticate with GWS Auth service.	telemetry_client
`TELEMETRY_CORS_DOMAIN`	Domains to be supported by CORS. This can a comma separated list. Important Add a `\` before `.` for regex matching. eg: `\.genesyslab\.com` (another `\` should be added when using quotes).
`TELEMETRY_TRACES_PROVIDER`	The trace provider to use can be `ElasticSearch` or `Console`	ElasticSearch
`TELEMETRY_TRACES_CONCURRENT`	The maximum of parallel bulk request to Elasticsearch at the same time.	3
`TELEMETRY_TRACES_THRESHOLD`	The maximum buffer entries for Elasticsearch service.	`400000`
`TELEMETRY_CONFIG_SERVICE`	The data source to fetch configuration information. Possible values : s3, azure, env, or an empty string.	none
`TELEMETRY_CONFIG_SERVICE_CORS`	This overrides data source to fetch CORS configurations. Possible values : Same value as `TELEMETRY_CONFIG_SERVICE` or `environmentservice` for using the environment-service API (Uses the `TELEMETRY_SERVICES_ENVIRONMENT` variable).	none
`TELEMETRY_CLOUD_PROVIDER`	Cloud provider for the service. Can be `aws`, `azure`, `gcp` or `premise`	`aws`
`TELEMETRY_CONFIG_CONTRACTS`	Stringified JSON array to provision contracts through `env` config provider	`[]`
`TELEMETRY_CONFIG_TENANTS`	A Stringified JSON to provision tenants through `env` config provider.	`{}`
`TELEMETRY_SERVICES_ENVIRONMENT`	The URL of the GWS environment service API. Used only if environment service is used for configuration provisioning.	value of `TELEMETRY_SERVICES_AUTH`	http://gauth-environment-active.gauth
serviceMonitoringAnnotations.enabled	Activation of Prometheus monitoring annotations on service.	true
podDisruptionBudget.enabled	Activation of pod disruption.	true
enableServiceLinks	Enable service links in single namespace environment.	false

---

You can modify the configuration to suit your environment by two methods:

• Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

  helm install telemetry-service.tgz --set tlm.replicaCount 4

• Specify the parameters to be modified in a values.yaml file.

  helm install --name tlm -f values.yaml telemetry-service.tgz

Configure Kubernetes

Document the layouts for the following so customers can create them if their Helm chart doesn't include a way to do this:

• ConfigMaps
• Secrets

NA

Configure security

List security-related settings, such as how to set up credentials and certificates for third-party services.

NA

Prepare an environment

Create a new project namespace for Telemetry:

kubectl create namespace tlm

See Creating namespaces for a list of approved namespaces.

Download the telemetry helm charts from the JFrog repository:

https://pureengage.jfrog.io/artifactory/helm-staging/tlm

Create a values-telemetry.yaml file and update the following parameters:

TELEMETRY_AUTH_CLIENT_SECRET: <CLIENT_SECRET GENEREATED FROM GAUTH>
TELEMETRY_AUTH_CLIENT_ID: <CLIENT_ID GENEREATED FROM GAUTH>
TELEMETRY_SERVICES_AUTH: "<GAUTH URL>"
TELEMETRY_CLOUD_PROVIDER: "GKE"
TELEMETRY_CORS_DOMAIN: "<domain for which cors has been enabled>"
grafanaDashboard:
  enabled: true

Copy the values-telemetry.yaml file and the tlm Helm package to the installation location.