Skip to content

Commit

Permalink
Fix spelling of transformation in docs/processing.md. (#7815)
Browse files Browse the repository at this point in the history
Signed-off-by: Gary McDonald <[email protected]>
  • Loading branch information
mcdonagj committed Jun 5, 2023
1 parent 6ababc9 commit 371fc45
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions docs/processing.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ This data can be navigated using field expressions, which are fields within the
the status message of a span is `status.message`. A map lookup can include the key as a string, for example `attributes["http.status_code"]`.

Operations are scoped to the type of a signal (`span`, `metric`, `log`), with all of the flattened points of that
signal being part of a tranformation space. Virtual fields are added to access data from a higher level before flattening, for
signal being part of a transformation space. Virtual fields are added to access data from a higher level before flattening, for
`resource`, `library_info`. For metrics, the structure presented for processing is actual data points, e.g. `NumberDataPoint`,
`HistogramDataPoint`, with the information from higher levels like `Metric` or the data type available as virtual fields.

Expand Down Expand Up @@ -140,7 +140,7 @@ contrib components, and in the future can even allow user plugins possibly throu
[HTTP proxies](https://github.com/proxy-wasm/spec). The arguments to operations will primarily be field expressions,
allowing the operation to mutate telemetry as needed.

There are times when the tranformation language input and the underlying telemetry model do not translate cleanly. For example, a span ID is represented in pdata as a SpanID struct, but in the tranformation language it is more natural to represent the span ID as a string or a byte array. The solution to this problem is Factories. Factories are functions that help translate between the tranformation language input into the underlying pdata structure. These types of functions do not change the telemetry in any way. Instead, they manipulate the tranformation language input into a form that will make working with the telemetry easier or more efficient.
There are times when the transformation language input and the underlying telemetry model do not translate cleanly. For example, a span ID is represented in pdata as a SpanID struct, but in the transformation language it is more natural to represent the span ID as a string or a byte array. The solution to this problem is Factories. Factories are functions that help translate between the transformation language input into the underlying pdata structure. These types of functions do not change the telemetry in any way. Instead, they manipulate the transformation language input into a form that will make working with the telemetry easier or more efficient.

### Examples

Expand Down Expand Up @@ -286,7 +286,7 @@ with unknown side effects may cause issues with optimization we will need to exp

## Declarative configuration

The telemetry tranformation language presents an SQL-like experience for defining telemetry transformations - it is made up of
The telemetry transformation language presents an SQL-like experience for defining telemetry transformations - it is made up of
the three primary components described above, however, and can be presented declaratively instead depending on what makes
sense as a user experience.

Expand All @@ -305,7 +305,7 @@ sense as a user experience.
- attributes["http.request.header.authorization"]
```

An implementation of the tranformation language would likely parse expressions into this sort of structure so given an SQL-like
An implementation of the transformation language would likely parse expressions into this sort of structure so given an SQL-like
implementation, it would likely be little overhead to support a YAML approach in addition.

## Function syntax
Expand Down Expand Up @@ -355,7 +355,7 @@ the `where ...` clause, as that will be handled by the framework before passing

## Embedded processors

The above describes a tranformation language for configuring processing logic in the OpenTelemetry collector. There will be a
The above describes a transformation language for configuring processing logic in the OpenTelemetry collector. There will be a
single processor that exposes the processing logic into the collector config; however, the logic will be implemented
within core packages rather than directly inside a processor. This is to ensure that where appropriate, processing
can be embedded into other components, for example metric processing is often most appropriate to execute within a
Expand All @@ -368,4 +368,4 @@ There are some known issues and limitations that we hope to address while iterat
- Handling array-typed attributes
- Working on a array of points, rather than a single point
- Metric alignment - for example defining an expression on two metrics, that may not be at the same timestamp
- The collector has separate pipelines per signal - while the tranformation language could apply cross-signal, we will need to remain single-signal for now
- The collector has separate pipelines per signal - while the transformation language could apply cross-signal, we will need to remain single-signal for now

0 comments on commit 371fc45

Please sign in to comment.