Skip to content

Commit

Permalink
primeiro commit
Browse files Browse the repository at this point in the history
  • Loading branch information
leandrocarpenter committed Aug 7, 2024
1 parent 57cd4f7 commit 0bc89e6
Show file tree
Hide file tree
Showing 5 changed files with 863 additions and 0 deletions.
30 changes: 30 additions & 0 deletions content/pt/docs/concepts/signals/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: Sinais
description: Aprenda sobre a 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 é colletar, processar e exportar **[signals][]**.
Sinais são saídas de sistemas que descrevem atividades fundamentais do
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,
como temperatura, memória utilizada, ou um evento que passa por um componente
de
something you want to measure at a specific point in time, like temperature or
memory usage, or an event that goes through the components of your distributed
system that you'd like to trace. You can group different signals together to
observe the inner workings of the same piece of technology under different
angles.

OpenTelemetry currently supports [traces](/docs/concepts/signals/traces),
[metrics](/docs/concepts/signals/metrics), [logs](/docs/concepts/signals/logs)
and [baggage](/docs/concepts/signals/baggage). _Events_ are a specific type of
log, and
[_profiles_ are being worked on](https://github.com/open-telemetry/oteps/blob/main/text/profiles/0212-profiling-vision.md)
by the Profiling Working Group.

[signals]: /docs/specs/otel/glossary/#signals
79 changes: 79 additions & 0 deletions content/pt/docs/concepts/signals/baggage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
---
title: Baggage
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
244 changes: 244 additions & 0 deletions content/pt/docs/concepts/signals/logs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,244 @@
---
title: Logs
description: A recording of an event.
weight: 3
cSpell:ignore: filelogreceiver semistructured transformprocessor
---

A **log** is a timestamped text record, either structured (recommended) or
unstructured, with optional metadata. Of all telemetry signals, logs have the
biggest legacy. Most programming languages have built-in logging capabilities or
well-known, widely used logging libraries.

## OpenTelemetry logs

OpenTelemetry does not define a bespoke API or SDK to create logs. Instead,
OpenTelemetry logs are the existing logs you already have from a logging
framework or infrastructure component. OpenTelemetry SDKs and
autoinstrumentation utilize several components to automatically correlate logs
with [traces](/docs/concepts/signals/traces).

OpenTelemetry's support for logs is designed to be fully compatible with what
you already have, providing capabilities to wrap those logs with additional
context and a common toolkit to parse and manipulate logs into a common format
across many different sources.

### OpenTelemetry logs in the OpenTelemetry Collector

The [OpenTelemetry Collector](/docs/collector) provides several tools to work
with logs:

- Several receivers which parse logs from specific, known sources of log data.
- The `filelogreceiver`, which reads logs from any file and provides features to
parse them from different formats or use a regular expression.
- Processors like the `transformprocessor` which lets you parse nested data,
flatten nested structures, add/remove/update values, and more.
- Exporters that let you emit log data in a non-OpenTelemetry format.

The first step in adopting OpenTelemetry frequently involves deploying a
Collector as a general-purposes logging agent.

### OpenTelemetry logs for applications

In applications, OpenTelemetry logs are created with any logging library or
built-in logging capabilities. When you add autoinstrumentation or activate an
SDK, OpenTelemetry will automatically correlate your existing logs with any
active trace and span, wrapping the log body with their IDs. In other words,
OpenTelemetry automatically correlates your logs and traces.

### Language support

Logs are a [stable](/docs/specs/otel/versioning-and-stability/#stable) signal in
the OpenTelemetry specification. For the individual language specific
implementations of the Logs API & SDK, the status is as follows:

{{% signal-support-table "logs" %}}

## Structured, unstructured, and semistructured logs

OpenTelemetry does not technically distinguish between structured and
unstructured logs. You can use any log you have with OpenTelemetry. However, not
all log formats are equally useful! Structured logs, in particular, are
recommended for production observability because they are easy to parse and
analyze at scale. The following section explains the differences between
structured, unstructured, and semistructured logs.

### Structured logs

A structured log is a log whose textual format follows a consistent,
machine-readable format. For applications, one of the most common formats is
JSON:

```json
{
"timestamp": "2024-08-04T12:34:56.789Z",
"level": "INFO",
"service": "user-authentication",
"environment": "production",
"message": "User login successful",
"context": {
"userId": "12345",
"username": "johndoe",
"ipAddress": "192.168.1.1",
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36"
},
"transactionId": "abcd-efgh-ijkl-mnop",
"duration": 200,
"request": {
"method": "POST",
"url": "/api/v1/login",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json"
},
"body": {
"username": "johndoe",
"password": "******"
}
},
"response": {
"statusCode": 200,
"body": {
"success": true,
"token": "jwt-token-here"
}
}
}
```

and for infrastructure components, Common Log Format (CLF) is commonly used:

```text
127.0.0.1 - johndoe [04/Aug/2024:12:34:56 -0400] "POST /api/v1/login HTTP/1.1" 200 1234
```

It is also common to have different structured log formats mixed together. For
example, an Extended Log Format (ELF) log can mix JSON with the
whitespace-separated data in a CLF log.

```text
192.168.1.1 - johndoe [04/Aug/2024:12:34:56 -0400] "POST /api/v1/login HTTP/1.1" 200 1234 "http://example.com" "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36" {"transactionId": "abcd-efgh-ijkl-mnop", "responseTime": 150, "requestBody": {"username": "johndoe"}, "responseHeaders": {"Content-Type": "application/json"}}
```

To make the most use of this log, parse both the JSON and the ELF-related pieces
into a shared format to make analysis on an observability backend easier. The
`filelogreceiver` in the [OpenTelemetry Collector](/docs/collector) contains
standardized ways to parse logs like this.

Structured logs are the preferred way to use logs. Because structured logs are
emitted in a consistent format, they are straightforward to parse, which makes
them easier to preprocess in an OpenTelemetry Collector, correlate with other
data, and ultimate analyze in an Observability backend.

### Unstructured logs

Unstructured logs are logs that don't follow a consistent structure. They may be
more human-readable, and are often used in development. However, it is not
preferred to use unstructured logs for production observability purposes, since
they are much more difficult to parse and analyze at scale.

Examples of unstructured logs:

```text
[ERROR] 2024-08-04 12:45:23 - Failed to connect to database. Exception: java.sql.SQLException: Timeout expired. Attempted reconnect 3 times. Server: db.example.com, Port: 5432
System reboot initiated at 2024-08-04 03:00:00 by user: admin. Reason: Scheduled maintenance. Services stopped: web-server, database, cache. Estimated downtime: 15 minutes.
DEBUG - 2024-08-04 09:30:15 - User johndoe performed action: file_upload. Filename: report_Q3_2024.pdf, Size: 2.3 MB, Duration: 5.2 seconds. Result: Success
```

It is possible to store and analyze Unstructured logs in production, although
you may need to do substantial work to parse or otherwise pre-process them to be
machine-readable. For example, the above three logs will require a regular
expression to parse their timestamps and custom parsers to consistently extract
the bodies of the log message. This will typically be necessary for a logging
backend to know how to sort and organize the logs by timestamp. Although it's
possible to parse unstructured logs for analysis purposes, doing this may be
more work than switching to structured logging, such as via a standard logging
framework in your applications.

### Semistructured logs

A semistructured log is a log that does use some self-consistent patterns to
distinguish data so that it's machine-readable, but may not use the same
formatting and delimiters between data across different systems.

Example of a semistructured log:

```text
2024-08-04T12:45:23Z level=ERROR service=user-authentication userId=12345 action=login message="Failed login attempt" error="Invalid password" ipAddress=192.168.1.1 userAgent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/104.0.0.0 Safari/537.36"
```

Although machine-readable, semistructured logs may require several different
parsers to allow for analysis at scale.

## OpenTelemetry logging components

The following lists of concepts and components power OpenTelemetry's logging
support.

### Log Appender / Bridge

As an application developer, the **Logs Bridge API** should not be called by you
directly, as it is provided for logging library authors to build log appenders /
bridges. Instead, you just use your preferred logging library and configure it
to use a log appender (or log bridge) that is able to emit logs into an
OpenTelemetry LogRecordExporter.

OpenTelemetry language SDKs offer this functionality.

### Logger Provider

> Part of the **Logs Bridge API** and should only be used if you are the author
> of a logging library.
A Logger Provider (sometimes called `LoggerProvider`) is a factory for
`Logger`s. In most cases, the Logger Provider is initialized once and its
lifecycle matches the application's lifecycle. Logger Provider initialization
also includes Resource and Exporter initialization.

### Logger

> Part of the **Logs Bridge API** and should only be used if you are the author
> of a logging library.
A Logger creates log records. Loggers are created from Log Providers.

### Log Record Exporter

Log Record Exporters send log records to a consumer. This consumer can be
standard output for debugging and development-time, the OpenTelemetry Collector,
or any open source or vendor backend of your choice.

### Log Record

A log record represents the recording of an event. In OpenTelemetry a log record
contains two kinds of fields:

- Named top-level fields of specific type and meaning
- Resource and attributes fields of arbitrary value and type

The top-level fields are:

| Field Name | Description |
| -------------------- | -------------------------------------------- |
| Timestamp | Time when the event occurred. |
| ObservedTimestamp | Time when the event was observed. |
| TraceId | Request trace ID. |
| SpanId | Request span ID. |
| TraceFlags | W3C trace flag. |
| SeverityText | The severity text (also known as log level). |
| SeverityNumber | Numerical value of the severity. |
| Body | The body of the log record. |
| Resource | Describes the source of the log. |
| InstrumentationScope | Describes the scope that emitted the log. |
| Attributes | Additional information about the event. |

For more details on log records and log fields, see
[Logs Data Model](/docs/specs/otel/logs/data-model/).

### Specification

To learn more about logs in OpenTelemetry, see the [logs specification][].

[logs specification]: /docs/specs/otel/overview/#log-signal
Loading

0 comments on commit 0bc89e6

Please sign in to comment.