Devprime | Documentação – Trace distribuído

Examples: Zipkin

Mon, 01 Jan 0001 00:00:00 +0000

A integração com o Open Telemetry é totalmente na nativa na plaraforma Devprime simplificando a jornada da pessoa desenvolvedora de software com a utilizaração desse recurso que agrega muito valor no cenário de sistemas distribuidos permitindo rastrear um processo de negócio em todos os microsserviços envolvidos.

As principais plataformas de Cloud do mercado já estão oferecendo suporte ao Open Telemetry o que facilita a adoção no ambiente de produção. Existe a opção de se utilizar no kubernetes ou qualquer outra solução gerenciada.

No contexto da nossa demonstração utilizaremos um container Docker local para termos o coletor dos dados e a ferramenta Zipkin.

Siga os passos abaixo:

Instale o Devprime CLI.
Inicialize o container do Zipkin disponibilizado na documentação do Docker.
Efetue o clone do repositório com os dois microsserviços (ms-order/ms-payment) ou implemente manualmente.
git clone https://github.com/devprime/devprime-microservices-order-payment.git.
Atualize o Stack executando na pasta principal para detectar os dois microsserviços
dp stack
Localize o arquivo de configuração na pasta de cada microsserviço que nesse exemplo citado no item 2 utilizaremos o “ms-order” e o “ms-payment”.

a) Abra o arquivo no Visual Studio Code dentro da pasta do microsserviço
code src/App/appsettings.json

b) Abra a chave Observability e verifique se a opção Enable está true. Depois vá na opção Trace e configure o Enable como true, Type como zipkin e o Endpoint com a url do serviço. No Docker local a url tem o valor padrão de “http://localhost:9411/api/v2/spans”.

 "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"
    }
  },

Execute o microsserviço ‘ms-order’ e observe no log que a informação configurada do Open Telemetry já estará em funcionamento. O log já demonstra que o Trace está como Enable e o Type definido como “ZipKin”.

1
2

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

Acompanhando o trace de um microsserviço

Execute o microsserviço ms-order
Abra no browser em http://localhost:5000 e faça um ou mais posts em /v1/order
Abra o Zipkin no browser em http://localhost:9411 e visualize

Verifique todos os detalhes do processamento

Acompanhando o trace de dois ou mais microsserviços

Execute os dois microsserviços (ms-order / ms-payment)
Efetue um post no microsserviço ms-order
Visualize os dtalhes no Zipkin

Informação legal:
O Zipkin é uma ferramenta opensource compatível com o padrão Open Telemetery. Qualquer informação sobre licenciamento e utilização recomendamos o fabricante.

Examples: Jaeger

Mon, 01 Jan 0001 00:00:00 +0000

Aqui está o texto revisado mantendo o conteúdo original:

A integração com o OpenTelemetry é nativa na plataforma Devprime, simplificando a jornada do desenvolvedor de software com a utilização desse recurso que agrega muito valor no cenário de sistemas distribuídos, permitindo rastrear um processo de negócio em todos os microsserviços envolvidos.

As principais plataformas de Cloud do mercado já oferecem suporte ao OpenTelemetry, o que facilita sua adoção em ambiente de produção. Existe a opção de utilizá-lo no Kubernetes ou em qualquer outra solução gerenciada.

No contexto da nossa demonstração, utilizaremos um container Docker local para configurar o coletor de dados e a ferramenta Jaeger. Para configurar, é necessário especificar o protocolo e o endpoint na configuração.

Protocolo	URL
grpc	http://localhost:4317
http	http://localhost:4318

Siga os passos abaixo:

Instale o Devprime CLI.
Inicialize o container do Jaeger disponibilizado na documentação do Docker.
Clone o repositório com os dois microsserviços (ms-order/ms-payment) ou implemente manualmente:
```
git clone https://github.com/devprime/devprime-microservices-order-payment.git
```
Entre na pasta clonada e execute o comando dp stack:
```
dp stack
```
a) Abra o arquivo no Visual Studio Code dentro da pasta de cada microsserviço:
```
code src/App/appsettings.json
```
b) Abra a chave Observability e verifique se a opção Enable está configurada como true. Em seguida, vá para a opção Trace e configure Enable como true, Type como Jaeger, e defina o host/port/endpoint com a URL do serviço de acordo com o protocolo (grpc/http). No Docker local, a URL padrão para grpc é “http://localhost:4317”.

 "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": "Jaeger",
      "Host": "localhost",
      "Port": "4317",
      "Endpoint": "http://localhost:4317",
      "Protocol": "grpc"
    }
  },

Execute o microsserviço ‘ms-order’ e observe no log que a informação configurada do Open Telemetry já estará em funcionamento. O log já demonstra que o Trace está como Enable e o Type definido como “Jaeger”.

1
2

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

Acompanhando o trace de dois ou mais microsserviços

Execute o microsserviço ms-order e ms-payment
Abra no browser em http://localhost:5000 e faça um ou mais posts em /v1/order
Abra o Jaeger no browser em http://localhost:16686 e visualize

Verifique todos os detalhes do processamento

Informação legal:
O Jaeger é uma ferramenta opensource compatível com o padrão Open Telemetery. Qualquer informação sobre licenciamento e utilização recomendamos o fabricante.