> For the complete documentation index, see [llms.txt](https://docs.digit.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digit.org/platform/guides/operations-guide/observability/jaeger-tracing-setup.md).
# Jaeger Tracing Setup
This doc will cover how you can set up the tracing on existing environments either with help of go lang script or Jenkins deployment jobs.
The Jaeger tracing system is an open-source tracing system for microservices, and it supports the OpenTracing standard.
## Pre-reads
[https://www.jaegertracing.io/docs](https://www.jaegertracing.io/docs/1.39/)\
[OAuth2-Proxy Setup](https://core.digit.org/guides/operations-guide/oauth2-proxy-setup)\\
## Pre-requisites
* DIGIT uses [golang](https://golang.org/doc/install#download) (required v1.13.3) automated scripts to deploy the builds onto Kubernetes - [Linux](https://golang.org/dl/go1.13.3.linux-amd64.tar.gz) or [Windows](https://golang.org/dl/go1.13.3.windows-amd64.msi) or [Mac](https://golang.org/dl/go1.13.3.darwin-amd64.pkg)
* All DIGIT services are packaged using helm charts[ Installing Helm](https://helm.sh/docs/intro/install/)
* [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) is a CLI to connect to the kubernetes cluster from your machine
* [Install Visualstudio](https://code.visualstudio.com/download) IDE Code for better code/configuration editing capabilities
* Git
* [OAuth2-Proxy Setup](https://core.digit.org/guides/operations-guide/oauth2-proxy-setup)
## Jaeger Tracing Glossary
Agent – A network daemon that listens for spans sent over User Datagram Protocol.
Client – The component that implements the OpenTracing API for distributed tracing.
Collector – The component that receives spans and adds them into a queue to be processed.
Console – A UI that enables users to visualize their distributed tracing data.
Query – A service that fetches traces from storage.
Span – The logical unit of work in Jaeger, which includes the name, starting time and duration of the operation.
Trace – The way Jaeger presents execution requests. A trace is composed of at least one span.
## Jaeger Deployment
1. Add below Jaeger configs in your env config file (eg. qa.yaml, dev.yaml and, etc…)
```
jaeger:
host: ""
port: ""
sampler-type: ""
sampler-param: ""
collector:
samplingConfig: |
{
"service_strategies": [
{
"service": "tl-services",
"type": "probabilistic",
"param": 0.5
},
{
"service": "tl-calculator",
"type": "probabilistic",
"param": 0.5
},
{
"service": "report-service",
"type": "probabilistic",
"param": 0.5
},
{
"service": "pt-services-v2",
"type": "probabilistic",
"param": 0.5
},
{
"service": "pt-calculator-v2",
"type": "probabilistic",
"param": 0.5
},
{
"service": "collection-services",
"type": "probabilistic",
"param": 0.2
},
{
"service": "billing-service",
"type": "probabilistic",
"param": 0.2
},
{
"service": "egov-data-uploader",
"type": "probabilistic",
"param": 0.2
},
{
"service": "egov-hrms",
"type": "probabilistic",
"param": 0.5
},
{
"service": "rainmaker-pgr",
"type": "probabilistic",
"param": 0.5
}
],
"default_strategy": {
"type": "probabilistic",
"param": 0.05
}
}
```
2\. You can deploy the Jaeger using one of the below methods.
* Deploy using go lang
* `go run main.go deploy -e -c 'jaeger'`
* Deploy using Jenkin’s respective deployment jobs
you can connect to the Jaeger console at [https://\/tracing/](https://egov-micro-qa.egovernments.org/tracing/search)
Look at the box on the left-hand side of the page labelled **Search.** The first control, a chooser, lists the services available for tracing, click the chooser and you’ll see the listed services.
Select the service and click the **Find Traces** button at the bottom of the form. You can now compare the duration of traces through the graph shown above. You can also filter traces using “Tags” section under “Find Traces”. For example, Setting the “error=true” tag will filter out all the jobs that have errors.
To view the detailed trace, you can select a specific trace instance and check details like the time taken by each service, errors during execution and logs.
## Additional Instructions
If due for some reason you are not able to access the tracing dashboard from your sub-domain, You can use the below command to access the tracing dashboard.
```
kubectl port-forward svc/jaeger-query 8080:80
```
**Note**: port 8080 is for local access, if you are utilizing the 8080 port you can use the different port as well.
To access the tracing hit the browser with this **localhost:8080** URL.
## **Reference Docs**
{% embed url="" %}
{% embed url="" %}
[**](http://creativecommons.org/licenses/by/4.0/)*All content on this page by* [*eGov Foundation*](https://egov.org.in/) *is licensed under a* [*Creative Commons Attribution 4.0 International License*](http://creativecommons.org/licenses/by/4.0/)*.*
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://docs.digit.org/platform/guides/operations-guide/observability/jaeger-tracing-setup.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.