-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[pt] Add signals concepts documentation #4993
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,80 @@ | ||||||
--- | ||||||
title: Bagagem | ||||||
weight: 4 | ||||||
description: Informações contextuais que são passadas entre sinais | ||||||
--- | ||||||
No OpenTelemetry, bagagem é uma informação adicional associada ao contexto. | ||||||
Bagagem é uma loja de chave-valor, o que significa que permite que você context. | ||||||
[propague](/docs/concepts/context-propagation/#propagation) qualquer dado que você | ||||||
goste ao lado[contexto](/docs/concepts/context-propagation/#context). | ||||||
Bagagem significa que você pode passar dados entre serviços e processos, | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Bagagem significa que você pode passar dados entre serviços e processos
Suggested change
|
||||||
tornando-os disponíveis para adicionar[traços](/docs/concepts/signals/traces/), | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
[metricas](/docs/concepts/signals/metrics/), or | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
[logs](/docs/concepts/signals/logs/) nesses serviços. | ||||||
|
||||||
## Example | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
Bagagem é frequentemente usada no rastreamento para propagar dados adicionais | ||||||
entre serviços. | ||||||
|
||||||
Por exemplo, imagine que você tem um `clientId` no início de uma solicitação, | ||||||
mas, você gostaria que esse ID estivesse disponível em todos os trechos em um | ||||||
rastreamento, algumas métricas em outro serviço, e alguns logs ao longo do caminho. | ||||||
Porque os rastros podem ter vários trechos em multiplos serviços, você precisa de | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
algumas maneiras para propagar esses dados sem copiar o `clientId` em muitos lugares | ||||||
na sua base de código. | ||||||
|
||||||
Ao usar. | ||||||
[Contexto Propagação](/docs/concepts/signals/traces/#context-propagation) para | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
passar bagagem através destes serviços, o `clientId` está disponível para adicionar | ||||||
a qualquer trecho, métricas ou logs. Além disso, as instrumentações propagam | ||||||
automaticamente a bagagem para você. | ||||||
|
||||||
![OTel Bagagem](/img/otel-baggage.svg) | ||||||
|
||||||
## Para que deve ser usada a bagagem Otel? | ||||||
|
||||||
|
||||||
Baggage is best used to include information typically available only at the | ||||||
start of a request further downstream. This can include things like Account | ||||||
Identification, User IDs, Product IDs, and origin IPs, for example. | ||||||
|
||||||
Propagating this information using baggage allows for deeper analysis of | ||||||
telemetry in a backend. For example, if you include information like a User ID | ||||||
on a span that tracks a database call, you can much more easily answer questions | ||||||
like "which users are experiencing the slowest database calls?" You can also log | ||||||
information about a downstream operation and include that same User ID in the | ||||||
log data. | ||||||
|
||||||
![OTel Baggage](/img/otel-baggage-2.svg) | ||||||
|
||||||
## Baggage security considerations | ||||||
|
||||||
Sensitive Baggage items can be shared with unintended resources, like | ||||||
third-party APIs. This is because automatic instrumentation includes Baggage in | ||||||
most of your service’s network requests. Specifically, Baggage and other parts | ||||||
of trace context are sent in HTTP headers, making it visible to anyone | ||||||
inspecting your network traffic. If traffic is restricted within your network, | ||||||
then this risk may not apply, but keep in mind that downstream services could | ||||||
propagate Baggage outside your network. | ||||||
|
||||||
Also, there are no built-in integrity checks to ensure that Baggage items are | ||||||
yours, so exercise caution when reading them. | ||||||
|
||||||
## Baggage is not the same as attributes | ||||||
|
||||||
An important thing to note about baggage is that it is a separate key-value | ||||||
store and is unassociated with attributes on spans, metrics, or logs without | ||||||
explicitly adding them. | ||||||
|
||||||
To add baggage entries to attributes, you need to explicitly read the data from | ||||||
baggage and add it as attributes to your spans, metrics, or logs. | ||||||
|
||||||
Because a common use cases for Baggage is to add data to | ||||||
[Span Attributes](/docs/concepts/signals/traces/#attributes) across a whole | ||||||
trace, several languages have Baggage Span Processors that add data from baggage | ||||||
as attributes on span creation. | ||||||
|
||||||
> For more information, see the [baggage specification][]. | ||||||
|
||||||
[baggage specification]: /docs/specs/otel/overview/#baggage-signal | ||||||
Comment on lines
+38
to
+80
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Acho que isso veio no commit por engano. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
title: Sinais | ||
description: Aprenda sobre as categorias de telemetria suportadas pelo OpenTelemetry. | ||
aliases: | ||
- /docs/concepts/data-sources | ||
- /docs/concepts/otel-concepts | ||
weight: 11 | ||
default_lang_commit: 08e13eb62f2869300301670675969be705db59ae | ||
--- | ||
|
||
O objetivo do OpenTelemetry é coletar, processar e exportar **[sinais][]**. | ||
Sinais são saídas de sistemas que descrevem atividades fundamentais do | ||
leandrocarpenter marked this conversation as resolved.
Show resolved
Hide resolved
|
||
sistema operacional e aplicações em execução na plataforma. Um sinal pode | ||
ser alguma coisa que você quer avaliar em algum ponto específico do tempo, | ||
por exemplo, memória utilizada, ou um evento que passa por um componente | ||
do seu sistema distribuido como um rastro. você pode agrupar diferentes sinais | ||
para observar o funcionamento interno da mesma tecnologia sob diferentes ângulos. | ||
|
||
OpenTelemetry atualmente suporta [rastros](/docs/concepts/signals/traces), | ||
[métricas](/docs/concepts/signals/metrics), [logs](/docs/concepts/signals/logs) | ||
e [baggage](/docs/concepts/signals/baggage). _Events_ são um tipo específico de logs e | ||
[_profiles_ estão em processo de construção](https://github.com/open-telemetry/oteps/blob/main/text/profiles/0212-profiling-vision.md) | ||
pelo Grupo de Trabalho de Profiling. | ||
|
||
[sinais]: /docs/specs/otel/glossary/#signals |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,79 @@ | ||
--- | ||
title: Baggage | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Acho que isso veio no commit por engano. |
||
weight: 4 | ||
description: Contextual information that is passed between signals. | ||
--- | ||
|
||
In OpenTelemetry, Baggage is contextual information that resides next to | ||
context. Baggage is a key-value store, which means it lets you | ||
[propagate](/docs/concepts/context-propagation/#propagation) any data you like | ||
alongside [context](/docs/concepts/context-propagation/#context). | ||
|
||
Baggage means you can pass data across services and processes, making it | ||
available to add to [traces](/docs/concepts/signals/traces/), | ||
[metrics](/docs/concepts/signals/metrics/), or | ||
[logs](/docs/concepts/signals/logs/) in those services. | ||
|
||
## Example | ||
|
||
Baggage is often used in tracing to propagate additional data across services. | ||
|
||
For example, imagine you have a `clientId` at the start of a request, but you'd | ||
like for that ID to be available on all spans in a trace, some metrics in | ||
another service, and some logs along the way. Because the trace may span | ||
multiple services, you need some way to propagate that data without copying the | ||
`clientId` across many places in your codebase. | ||
|
||
By using | ||
[Context Propagation](/docs/concepts/signals/traces/#context-propagation) to | ||
pass baggage across these services, the `clientId` is available to add to any | ||
additional spans, metrics, or logs. Additionally, instrumentations automatically | ||
propagate baggage for you. | ||
|
||
![OTel Baggage](/img/otel-baggage.svg) | ||
|
||
## What should OTel Baggage be used for? | ||
|
||
Baggage is best used to include information typically available only at the | ||
start of a request further downstream. This can include things like Account | ||
Identification, User IDs, Product IDs, and origin IPs, for example. | ||
|
||
Propagating this information using baggage allows for deeper analysis of | ||
telemetry in a backend. For example, if you include information like a User ID | ||
on a span that tracks a database call, you can much more easily answer questions | ||
like "which users are experiencing the slowest database calls?" You can also log | ||
information about a downstream operation and include that same User ID in the | ||
log data. | ||
|
||
![OTel Baggage](/img/otel-baggage-2.svg) | ||
|
||
## Baggage security considerations | ||
|
||
Sensitive Baggage items can be shared with unintended resources, like | ||
third-party APIs. This is because automatic instrumentation includes Baggage in | ||
most of your service’s network requests. Specifically, Baggage and other parts | ||
of trace context are sent in HTTP headers, making it visible to anyone | ||
inspecting your network traffic. If traffic is restricted within your network, | ||
then this risk may not apply, but keep in mind that downstream services could | ||
propagate Baggage outside your network. | ||
|
||
Also, there are no built-in integrity checks to ensure that Baggage items are | ||
yours, so exercise caution when reading them. | ||
|
||
## Baggage is not the same as attributes | ||
|
||
An important thing to note about baggage is that it is a separate key-value | ||
store and is unassociated with attributes on spans, metrics, or logs without | ||
explicitly adding them. | ||
|
||
To add baggage entries to attributes, you need to explicitly read the data from | ||
baggage and add it as attributes to your spans, metrics, or logs. | ||
|
||
Because a common use cases for Baggage is to add data to | ||
[Span Attributes](/docs/concepts/signals/traces/#attributes) across a whole | ||
trace, several languages have Baggage Span Processors that add data from baggage | ||
as attributes on span creation. | ||
|
||
> For more information, see the [baggage specification][]. | ||
|
||
[baggage specification]: /docs/specs/otel/overview/#baggage-signal |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.