|
| 1 | +--- |
| 2 | +title: Configurações gerais de SDK |
| 3 | +linkTitle: Geral |
| 4 | +aliases: [general-sdk-configuration] |
| 5 | +cSpell:ignore: ottrace |
| 6 | +default_lang_commit: 1e4970e9193c8af1d1f9b86901b13492071aecc7 |
| 7 | +--- |
| 8 | + |
| 9 | +{{% alert title="Nota" color="info" %}} |
| 10 | + |
| 11 | +O suporte a variáveis de ambiente é opcional. Para informações detalhadas sobre |
| 12 | +quais variáveis de ambiente cada implementação de linguagem suporta, consulte a |
| 13 | +[Matriz de Conformidade de Implementação](https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix.md#environment-variables). |
| 14 | + |
| 15 | +{{% /alert %}} |
| 16 | + |
| 17 | +## `OTEL_SERVICE_NAME` |
| 18 | + |
| 19 | +Define o valor do atributo de recurso |
| 20 | +[`service.name`](/docs/specs/semconv/resource/#service). |
| 21 | + |
| 22 | +**Valor padrão:** `"unknown_service"` |
| 23 | + |
| 24 | +Se `service.name` também for fornecido em `OTEL_RESOURCE_ATTRIBUTES`, então |
| 25 | +`OTEL_SERVICE_NAME` terá precedência. |
| 26 | + |
| 27 | +**Exemplo:** |
| 28 | + |
| 29 | +`export OTEL_SERVICE_NAME="your-service-name"` |
| 30 | + |
| 31 | +## `OTEL_RESOURCE_ATTRIBUTES` |
| 32 | + |
| 33 | +Pares de chave-valor que serão utilizados como atributos de recurso. Consulte a |
| 34 | +página de |
| 35 | +[Recurso do SDK](/docs/specs/otel/resource/sdk#specifying-resource-information-via-an-environment-variable) |
| 36 | +para mais detalhes. |
| 37 | + |
| 38 | +**Valor padrão:** Vazio. |
| 39 | + |
| 40 | +Consulte a página |
| 41 | +[convenção semântica de Recursos](/docs/specs/semconv/resource/#semantic-attributes-with-sdk-provided-default-value) |
| 42 | +para obter informações sobre as convenções semânticas a serem seguidas para |
| 43 | +tipos de recursos comuns. |
| 44 | + |
| 45 | +**Exemplo:** |
| 46 | + |
| 47 | +`export OTEL_RESOURCE_ATTRIBUTES="key1=value1,key2=value2"` |
| 48 | + |
| 49 | +## `OTEL_TRACES_SAMPLER` |
| 50 | + |
| 51 | +Especifica o Sampler utilizado pelo SDK para realizar amostragem de rastros. |
| 52 | + |
| 53 | +**Valor padrão:** `"parentbased_always_on"` |
| 54 | + |
| 55 | +**Exemplo:** |
| 56 | + |
| 57 | +`export OTEL_TRACES_SAMPLER="traceidratio"` |
| 58 | + |
| 59 | +Os valores aceitos para `OTEL_TRACES_SAMPLER` são: |
| 60 | + |
| 61 | +- `"always_on"`: `AlwaysOnSampler` |
| 62 | +- `"always_off"`: `AlwaysOffSampler` |
| 63 | +- `"traceidratio"`: `TraceIdRatioBased` |
| 64 | +- `"parentbased_always_on"`: `ParentBased(root=AlwaysOnSampler)` |
| 65 | +- `"parentbased_always_off"`: `ParentBased(root=AlwaysOffSampler)` |
| 66 | +- `"parentbased_traceidratio"`: `ParentBased(root=TraceIdRatioBased)` |
| 67 | +- `"parentbased_jaeger_remote"`: `ParentBased(root=JaegerRemoteSampler)` |
| 68 | +- `"jaeger_remote"`: `JaegerRemoteSampler` |
| 69 | +- `"xray"`: |
| 70 | + [AWS X-Ray Centralized Sampling](https://docs.aws.amazon.com/xray/latest/devguide/xray-console-sampling.html) |
| 71 | + (_terceiro_) |
| 72 | + |
| 73 | +## `OTEL_TRACES_SAMPLER_ARG` |
| 74 | + |
| 75 | +Especifica os argumentos, se aplicável, para o Sampler definido em |
| 76 | +`OTEL_TRACES_SAMPLER`. O valor especificado será utilizado apenas se |
| 77 | +`OTEL_TRACES_SAMPLER` for definido. Cada tipo de Sampler define sua própria |
| 78 | +entrada esperada, se houver. Entradas inválidas ou não reconhecidas são |
| 79 | +registradas como erro. |
| 80 | + |
| 81 | +**Valor padrão:** Vazio. |
| 82 | + |
| 83 | +**Exemplo:** |
| 84 | + |
| 85 | +```shell |
| 86 | +export OTEL_TRACES_SAMPLER="traceidratio" |
| 87 | +export OTEL_TRACES_SAMPLER_ARG="0.5" |
| 88 | +``` |
| 89 | + |
| 90 | +Dependendo do valor definido em `OTEL_TRACES_SAMPLER`, a definição de |
| 91 | +`OTEL_TRACES_SAMPLER_ARG` pode ocorrer da seguinte maneira: |
| 92 | + |
| 93 | +- Para os Samplers `traceidratio` e `parentbased_traceidratio`: Probabilidade de |
| 94 | + amostragem, um número no intervalo [0..1], por exemplo, "0.25". Caso não seja |
| 95 | + definido, o valor padrão é 1.0. |
| 96 | +- Para `jaeger_remote` e `parentbased_jaeger_remote`: O valor é uma lista |
| 97 | + separada por vírgulas: |
| 98 | + - Exemplo: |
| 99 | + `"endpoint=http://localhost:14250,pollingIntervalMs=5000,initialSamplingRate=0.25"` |
| 100 | + - `endpoint`: A rota em formato `scheme://host:port` do servidor gRPC que |
| 101 | + fornece a estratégia de amostragem para o serviço |
| 102 | + ([sampling.proto](https://github.com/jaegertracing/jaeger-idl/blob/main/proto/api_v2/sampling.proto)). |
| 103 | + - `pollingIntervalMs`: em milissegundos, indicando com que frequência o |
| 104 | + Sampler consultará o _backend_ para atualizações na estratégia de |
| 105 | + amostragem. |
| 106 | + - `initialSamplingRate`: no intervalo [0..1], utilizado como valor da |
| 107 | + probabilidade de amostragem caso não seja possível recuperar a estratégia de |
| 108 | + amostragem no _backend_. Este valor perde efeito assim que uma estratégia de |
| 109 | + amostragem é recuperada com sucesso, então a estratégia remota será |
| 110 | + utilizada até que uma nova atualização seja obtida com sucesso. |
| 111 | + |
| 112 | +## `OTEL_PROPAGATORS` |
| 113 | + |
| 114 | +Especifica os Propagators a serem utilizados em uma lista separada por vírgulas. |
| 115 | + |
| 116 | +**Valor padrão:** `"tracecontext,baggage" |
| 117 | + |
| 118 | +**Exemplo:** |
| 119 | + |
| 120 | +`export OTEL_PROPAGATORS="b3"` |
| 121 | + |
| 122 | +Os valores aceitos para `OTEL_PROPAGATORS` são: |
| 123 | + |
| 124 | +- `"tracecontext"`: [W3C Trace Context](https://www.w3.org/TR/trace-context/) |
| 125 | +- `"baggage"`: [W3C Baggage](https://www.w3.org/TR/baggage/) |
| 126 | +- `"b3"`: [B3 Single](/docs/specs/otel/context/api-propagators#configuration) |
| 127 | +- `"b3multi"`: |
| 128 | + [B3 Multi](/docs/specs/otel/context/api-propagators#configuration) |
| 129 | +- `"jaeger"`: |
| 130 | + [Jaeger](https://www.jaegertracing.io/docs/1.21/client-libraries/#propagation-format) |
| 131 | +- `"xray"`: |
| 132 | + [AWS X-Ray](https://docs.aws.amazon.com/xray/latest/devguide/xray-concepts.html#xray-concepts-tracingheader) |
| 133 | + (_terceiro_) |
| 134 | +- `"ottrace"`: |
| 135 | + [OT Trace](https://github.com/opentracing?q=basic&type=&language=) |
| 136 | + (_terceiro_) |
| 137 | +- `"none"`: Nenhum propagador configurado automaticamente. |
| 138 | + |
| 139 | +## `OTEL_TRACES_EXPORTER` |
| 140 | + |
| 141 | +Especifica qual Exporter é utilizado para os rastros. Dependendo da |
| 142 | +implementação, pode ser uma lista separada por vírgulas. |
| 143 | + |
| 144 | +**Valor padrão:** `"otlp"` |
| 145 | + |
| 146 | +**Exemplo:** |
| 147 | + |
| 148 | +`export OTEL_TRACES_EXPORTER="jaeger"` |
| 149 | + |
| 150 | +Os valores aceitos são: |
| 151 | + |
| 152 | +- `"otlp"`: [OTLP][] |
| 153 | +- `"jaeger"`: exportar no modelo de dados Jaeger |
| 154 | +- `"zipkin"`: [Zipkin](https://zipkin.io/zipkin-api/) |
| 155 | +- `"console"`: [Saída Padrão](/docs/specs/otel/trace/sdk_exporters/stdout/) |
| 156 | +- `"none"`: Nenhum exportador de rastros configurado automaticamente. |
| 157 | + |
| 158 | +## `OTEL_METRICS_EXPORTER` |
| 159 | + |
| 160 | +Especifica qual Exporter é utilizado para as métricas. Dependendo da |
| 161 | +implementação, pode ser uma lista separada por vírgulas. |
| 162 | + |
| 163 | +**Valor padrão:** `"otlp"` |
| 164 | + |
| 165 | +**Exemplo:** |
| 166 | + |
| 167 | +`export OTEL_METRICS_EXPORTER="prometheus"` |
| 168 | + |
| 169 | +Os valores aceitos para `OTEL_METRICS_EXPORTER` são: |
| 170 | + |
| 171 | +- `"otlp"`: [OTLP][] |
| 172 | +- `"prometheus"`: |
| 173 | + [Prometheus](https://github.com/prometheus/docs/blob/main/content/docs/instrumenting/exposition_formats.md) |
| 174 | +- `"console"`: [Saída Padrão](/docs/specs/otel/metrics/sdk_exporters/stdout/) |
| 175 | +- `"none"`: Nenhum exportador de métricas configurado automaticamente. |
| 176 | + |
| 177 | +## `OTEL_LOGS_EXPORTER` |
| 178 | + |
| 179 | +Especifica qual Exporter é utilizado para os logs. Dependendo da implementação, |
| 180 | +pode ser uma lista separada por vírgulas. |
| 181 | + |
| 182 | +**Valor padrão:** `"otlp"` |
| 183 | + |
| 184 | +**Exemplo:** |
| 185 | + |
| 186 | +`export OTEL_LOGS_EXPORTER="otlp"` |
| 187 | + |
| 188 | +Os valores aceitos para `OTEL_LOGS_EXPORTER` são: |
| 189 | + |
| 190 | +- `"otlp"`: [OTLP][] |
| 191 | +- `"console"`: [Saída Padrão](/docs/specs/otel/logs/sdk_exporters/stdout/) |
| 192 | +- `"none"`: Nenhum exportador de logs configurado automaticamente. |
| 193 | + |
| 194 | +[otlp]: /docs/specs/otlp/ |
0 commit comments