Skip to content
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

Closed

Conversation

leandrocarpenter
Copy link

@leandrocarpenter leandrocarpenter commented Aug 7, 2024

Docs PR Checklist

  • This PR is for a documentation page whose authoritative copy is in the
    opentelemetry.io repository.

  • Primeira tradução da pagina de signals.

@leandrocarpenter leandrocarpenter requested a review from a team August 7, 2024 15:49
Copy link

linux-foundation-easycla bot commented Aug 7, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

@emdneto emdneto changed the title [pt-br] Add_pt_br_signals [pt] Add signals concepts documentation Aug 7, 2024
@emdneto
Copy link
Member

emdneto commented Aug 7, 2024

PTAL @edsoncelio @EzzioMoreira

Copy link
Contributor

@pedroespindula pedroespindula left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deixei alguns comentários, mas também gostaria da validação dos comentários propostos. Mesmo assim, excelente tradução, @leandrocarpenter!

content/pt/docs/concepts/signals/_index.md Outdated Show resolved Hide resolved
content/pt/docs/concepts/signals/_index.md Show resolved Hide resolved
content/pt/docs/concepts/signals/_index.md Outdated Show resolved Hide resolved
content/pt/docs/concepts/signals/_index.md Outdated Show resolved Hide resolved
@edsoncelio
Copy link
Member

Opa @leandrocarpenter!
Primeiramente muito obrigado pela contribuição!

Queria deixar uma sugestão, o que acha de quebrar esse PR em vários?
Assim facilita o processo de revisão, dado que são páginas consideravelmente grandes, você vai ter o seu PR aprovado mais rápido, e outras pessoas podem trabalhar nas outras páginas .

O que eu sugiro de fazer nesse PR:

  • signals/_index.md
  • signals/baggage.md

Os outros pode deixar pra outro PR, o que acha?

@EzzioMoreira
Copy link
Contributor

@leandrocarpenter acho que no seu último commit veio documentos da localização [EN]. Quando puder dá uma olhada nos files changed

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Bagagem é uma loja de chave-valor, o que significa que permite que você context.
Bagagem é uma estrutura de armazenamento de chave-valor, que permite você propagar quaisquer dados junto com o contexto.

@emdneto emdneto marked this pull request as draft August 13, 2024 12:05
goste ao lado[contexto](/docs/concepts/context-propagation/#context).
Bagagem significa que você pode passar dados entre serviços e processos,
tornando-os disponíveis para adicionar[traços](/docs/concepts/signals/traces/),
[metricas](/docs/concepts/signals/metrics/), or
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[metricas](/docs/concepts/signals/metrics/), or
[métricas](/docs/concepts/signals/metrics/), ou

[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,
tornando-os disponíveis para adicionar[traços](/docs/concepts/signals/traces/),
Copy link
Contributor

@EzzioMoreira EzzioMoreira Aug 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
tornando-os disponíveis para adicionar[traços](/docs/concepts/signals/traces/),
tornando-os disponíveis para adicionar aos [rastros](/docs/concepts/signals/traces/),

[metricas](/docs/concepts/signals/metrics/), or
[logs](/docs/concepts/signals/logs/) nesses serviços.

## Example
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Example
## Exemplo

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Porque os rastros podem ter vários trechos em multiplos serviços, você precisa de
Porque os rastros podem ter vários trechos em múltiplos serviços, você precisa de

na sua base de código.

Ao usar.
[Contexto Propagação](/docs/concepts/signals/traces/#context-propagation) para
Copy link
Contributor

@EzzioMoreira EzzioMoreira Aug 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
[Contexto Propagação](/docs/concepts/signals/traces/#context-propagation) para
[Propagação de Contexto](/docs/concepts/signals/traces/#context-propagation) para

Comment on lines +38 to +80
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Acho que isso veio no commit por engano.

@@ -0,0 +1,79 @@
---
title: Baggage
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Acho que isso veio no commit por engano.

@@ -0,0 +1,244 @@
---
title: Logs
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Acho que isso veio no commit por engano.

@@ -0,0 +1,122 @@
---
title: Metrics
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Acho que isso veio no commit por engano.

@@ -0,0 +1,388 @@
---
title: Traces
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Acho que isso veio no commit por engano.

@emdneto
Copy link
Member

emdneto commented Aug 27, 2024

@leandrocarpenter gentle remind: você ainda está trabalhando nesse PR ou outra pessoa pode assumir de onde você parou?

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,
Copy link
Contributor

Choose a reason for hiding this comment

The 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
Bagagem significa que você pode passar dados entre serviços e processos,
Bagagem significa que você pode transportar dados entre serviços e processos,

@EzzioMoreira
Copy link
Contributor

@leandrocarpenter vou puxar a continuidade dessa localização.

@leandrocarpenter
Copy link
Author

Pessoal, me desculpem, não consegui dar continuidade.
Na próxima semana aviso no canal para continuar.

@EzzioMoreira
Copy link
Contributor

@leandrocarpenter fica tranquilo, no último encontro o time decidiu fechar a tradução dos conceitos e seguir para próxima etapa.
Subi esse PR que atualiza seu PR:
#5188

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

6 participants