Adicionar ao registro

Como adicionar entradas ao registro.

Você mantém ou contribui para uma integração do OpenTelemetry? Adoraríamos destacar o seu projeto no registro!

Para adicionar o seu projeto, envie um pull request. Será necessário criar um arquivo de dados em data/registry para o seu projeto, utilizando o seguinte modelo: registry-entry.yml.

Certifique-se de que os nomes e descrições do seu projeto sigam as nossas marketing guidelines e estejam alinhados com as diretrizes de marca e trademark usage guidelines da Linux Foundation.

Tipos de registro

Ao adicionar seu projeto ao registro, você precisa especificar um registryType (tipo de registro). Este campo categoriza seu projeto com base em sua relação com o OpenTelemetry. Abaixo estão os possíveis valores e suas definições:

application integration

Use para: Aplicações ou serviços que possuem OpenTelemetry integrado nativamente (suporte embutido) sem necessidade de plugins externos ou bibliotecas de instrumentação.

Exemplos: Veja a lista de integrações nativas de aplicações na página Integrações.

core

Use para: Somente componentes principais do projeto OpenTelemetry. Isso nunca se aplica a componentes de terceiros ou componentes que não fazem parte do projeto OpenTelemetry.

exporter

Use para: Componentes exportadores do OpenTelemetry Collector ou bibliotecas exportadoras dentro dos SDKs específicos de linguagem.

Exemplos: Exportadores OTLP, exportadores Prometheus ou qualquer componente que envie dados de telemetria para sistemas externos.

Nota: Não aplicável para componentes de terceiros que exportam dados de telemetria.

extension

Use para: Extensões do Collector ou SDK que ampliam a funcionalidade do OpenTelemetry.

Exemplos: Autenticadores, fontes/provedores de configuração, descoberta de serviços, health checks/pprof/zpages, ou outros componentes que ampliam o comportamento do Collector/SDK.

instrumentation

Use para: Bibliotecas de instrumentação ou instrumentações nativas para bibliotecas/frameworks específicos.

Exemplos: Instrumentação HTTP, instrumentação de banco de dados, instrumentação específica de framework, ou agentes de auto-instrumentação quando aplicável.

log-bridge

Use para: Adaptadores específicos de linguagem que conectam frameworks/APIs de logging existentes ao logging do OpenTelemetry, permitindo que aplicativos emitam logs OTel por meio de APIs de logging familiares.

Exemplos: Bridges/handlers/appenders para frameworks como Java SLF4J/Log4j/Logback, Python logging, JavaScript Winston/Pino, e Go log/slog/zap.

processor

Use para: Componentes processadores do OpenTelemetry Collector.

Exemplos: Processadores em lote, processadores de atributos, processadores de amostragem, ou qualquer componente que processe dados de telemetria dentro do pipeline do Collector.

provider

Use para: Componentes provedores do OpenTelemetry Collector.

Exemplos: Provedores de configuração, provedores de credenciais, ou qualquer componente que forneça recursos ou configuração para o Collector.

receiver

Use para: Componentes recebedores do OpenTelemetry Collector.

Exemplos: Recebedores OTLP, recebedores Prometheus, ou qualquer componente que receba dados de telemetria de fontes externas.

resource-detector

Use para: Detectores de recursos para SDKs específicos de linguagem.

Exemplos: Detectores de recursos AWS, detectores de recursos GCP, ou qualquer componente que detecte automaticamente e adicione informações de recursos à telemetria.

utilities

Use para: Qualquer outra ferramenta que as pessoas possam utilizar para trabalhar com OpenTelemetry.

Exemplos: Utilitários de teste, ferramentas de depuração (debugging), ferramentas de migração, ou qualquer biblioteca auxiliar que facilite o trabalho com OpenTelemetry.