K8 Configuration
In order to enable tracing in Microservices, following configurations are to be added.
| Configuration | Configuration Description |
|---|---|
| temn.msf.tracer.enabled: boolean (Eg true or false) | Switch to enable or disable tracer functionality for a given service. |
| temn.tracer.host: hostname (Eg jaeger or "172.25.0.7") | Hostname or Service name of any tracer backend service. (Currently we are using Jaeger) |
| temn.tracer.port: 4317 | Port number of tracer backend service. |
| temn.msf.service.name: Any string (Eg INGESTER) | When given will be used to generate name of service Eg TEMN-MICROSERVICE-{MSname}-{service-name} |
Tracing can be monitored for all the type of services such as API and ingestion. Following is an example configuration for the API services to be monitored.
Enable Tracing in Docker
To configure in Docker, set the following Tracing configuration properties as Environment Variables in savingspot-configmap.yaml. The refers the start scripts tart-savingspot-mongo.bat / start-savingspot-mongo.sh / start-savingspot-postgresql.bat./ start-savingspot-postgresql.sh for the value of the respective Tracer properties.
By default, Jaeger is disabled. To enable it, set the property temn_msf_tracer_enabled as true. The host port should be the system IP address before the service.
savingspot-configmap.yaml
#--- Tracer Configuration ---
{{- if .Values.tracing.enabled }}
temn.msf.service.name: "spApi"
temn.msf.tracer.enabled: {{ .Values.tracing.enabled | quote}}
temn.tracer.host: {{ .Values.tracing.host | quote}}
temn.tracer.port: {{ .Values.tracing.port | quote}}
{{- end }}
The same properties are added in the executable K8 start scripts, with the variables passed as a part of the helm install/ upgrade command.
start-savingspot-mongo.bat
REM # Tracer Configuration Setup SET tracer_enabled= false SET tracer_host= 127.0.0.1 SET tracer_port= 4317 helm install spnosql ./svc -n %SVC_NAMESPACE% --set tracing.enabled=%tracer_enabled% --set tracing.port=%tracer_port% --set tracing.host=%tracer_host%
If value for a property are not set in start scripts, then the respective configuration properties values will be taken from values.yaml.
Navigate to the K8 stack and edit corresponding values.yaml file. In the values.yaml file, the following properties are added:
values.yaml
tracing: enabled: false port: 4317 host: 127.0.0.1
In this topic