Zipkin

The integration with Open Telemetry is fully native in the Devprime platform, simplifying the journey of the software developer with the use of this resource that adds a lot of value in the scenario of distributed systems, allowing you to track a business process in all the microservices involved.

The main Cloud platforms in the market are already supporting Open Telemetry, which facilitates adoption in the production environment. There is the option to use it in kubernetes or any other managed solution.

In the context of our demonstration we will use a local docker container to have the data collector and the Zipkin tool.

Follow the steps below:

1. Install the Devprime CLI.

2. Initialize the Zipkin container provided in the docker documentation.

3. Clone the repository with the two microservices (ms-order/ms-payment) or deploy manually.
   git clone https://github.com/devprime/devprime-microservices-order-payment.git.

4. Update the Stack by running in the main folder to detect the two microservices
   dp stack

5. Locate the configuration file in the folder of each microservice that in this example mentioned in item 2 we will use “ms-order” and “ms-payment”.

a) Open the file in Visual Studio Code inside the microservice folder
code src/App/appsettings.json

b) Open the Observability key and verify that the Enable option is true. Then go to the Trace option and set the Enable to true, Type to zipkin and the Endpoint with the url of the service. In local docker the url has the default value of “http://localhost:9411/api/v2/spans”.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

 "Devprime_Observability": {
    "Enable": "true",
    "Log": {
      "Enable": "true",
      "Save": "false",
      "Type": "text",
      "FileSize": "5242880",
      "HideDetails": "false",
      "HideDateTime": "false",
      "ShowAppName": "false",
      "Path": "",
      "ShowHttpErrors": "400",
      "Export": {
        "Enable": "false",
        "Type": "seq",
        "Host": "http://localhost:5341",
        "ApiKey": "your api key",
        "ControlLevelSwitch": "Information"
      }
    },
    "Metrics": {
      "Enable": "false"
    },
    "Trace": {
      "Enable": "true",
      "Type": "zipkin",
      "Endpoint": "http://localhost:9411/api/v2/spans"
    }
  },

6. Run the ‘ms-order’ microservice and notice in the log that the configured Open Telemetry information will already be in place. The log already shows that the Trace is set to Enable and the Type set to “ZipKin”.

1
2

[App][Observability]["Enable"][Log "Enable"][Export "Disable"]
[Trace "Enable"][Type "zipkin"][Metrics "Disable"]

Tracking the trace of a microservice

1. Run the ms-order microservice
2. Open the browser in http://localhost:5000 and make one or more posts in /v1/order
3. Open Zipkin in the browser in http://localhost:9411 and view

4. Check all processing details

Tracking the trace of two or more microservices

1. Run both microservices (ms-order / ms-payment)
2. Make a post to the ms-order microservice
3. View details on Zipkin

Legal information:
Zipkin is an opensource tool compatible with the Open Telemetery standard. Any information on licensing and use we recommend the manufacturer.