fix typos and consistency (#2135)

This commit is contained in:
Michael 2022-12-30 00:07:52 +08:00 committed by GitHub
parent c555dc8f47
commit 53623f7549
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 16 deletions

View File

@ -31,7 +31,7 @@ In order to implement a traces receiver you will need the following:
its configurations within the Collector's config.yaml. its configurations within the Collector's config.yaml.
- A `ReceiverFactory` implementation so the Collector can properly instantiate - A `ReceiverFactory` implementation so the Collector can properly instantiate
the trace receiver component the trace receiver component.
- A `TracesReceiver` implementation that is responsible to collect the - A `TracesReceiver` implementation that is responsible to collect the
telemetry, convert it to the internal trace representation, and hand the telemetry, convert it to the internal trace representation, and hand the
@ -44,7 +44,8 @@ above in order to create the receiver, so let's get started.
## Setting up your receiver development and testing environment ## Setting up your receiver development and testing environment
First use the [Building a Custom Collector](/docs/collector/custom-collector) tutorial to create a Collector instance named `dev-otelcol`; all you need is to First use the [Building a Custom Collector](/docs/collector/custom-collector) tutorial
to create a Collector instance named `dev-otelcol`; all you need is to
copy the `builder-config.yaml` described on Step 2 and make the following changes: copy the `builder-config.yaml` described on Step 2 and make the following changes:
```yaml ```yaml
@ -146,7 +147,7 @@ successfully established a connection to your local Jaeger instance. Now that we
have our environment ready, let's start writing your receiver's code. have our environment ready, let's start writing your receiver's code.
Now, create another folder called `tailtracer` so we can have a place to host Now, create another folder called `tailtracer` so we can have a place to host
all of our receiver code all of our receiver code.
```cmd ```cmd
mkdir tailtracer mkdir tailtracer
@ -171,7 +172,7 @@ The `tailtracer` receiver will have the following settings:
- `interval`: a string representing the time interval (in minutes) between - `interval`: a string representing the time interval (in minutes) between
telemetry pull operations telemetry pull operations
- `number_of_traces`: the number os mock traces generated for each interval - `number_of_traces`: the number of mock traces generated for each interval
Here is what the `tailtracer` receiver settings will look like: Here is what the `tailtracer` receiver settings will look like:
@ -191,7 +192,7 @@ touch config.go
``` ```
To implement the configuration aspects of a receiver you need create a `Config` To implement the configuration aspects of a receiver you need create a `Config`
struct, so go ahead the add the following code to your `config.go` file: struct, so go ahead and add the following code to your `config.go` file:
```go ```go
package tailtracer package tailtracer
@ -211,7 +212,7 @@ struct must:
- Add a field for each of the receiver's settings. - Add a field for each of the receiver's settings.
Here is what your config.go file should look like after you implemented the Here is what your config.go file should look like after you implemented the
requirements above requirements above.
> config.go > config.go
@ -245,7 +246,7 @@ needed for those values by implementing the `Validate` method according to the
interface. interface.
In this case, the `interval` value will be optional (we will look at generating In this case, the `interval` value will be optional (we will look at generating
default values later) but when defined should be at least 1 minute (1m) and the default values later) but when defined should be at least 1 minute (1m) and
the `number_of_traces` will be a required value. Here is what the config.go the `number_of_traces` will be a required value. Here is what the config.go
looks like after implementing the `Validate` method. looks like after implementing the `Validate` method.
@ -368,7 +369,7 @@ implementation is by using the functions available within the
### Implementing your ReceiverFactory ### Implementing your ReceiverFactory
Start by creating a file named factory.go within the `tailtracer` folder Start by creating a file named factory.go within the `tailtracer` folder.
```cmd ```cmd
cd tailtracer cd tailtracer
@ -412,7 +413,7 @@ The `component.NewReceiverFactory()` instantiates and returns a
determine what type of signal your receiver is capable of processing. determine what type of signal your receiver is capable of processing.
Let's now implement the code to support all the parameters required by Let's now implement the code to support all the parameters required by
`component.NewReceiverFactory()` `component.NewReceiverFactory()`.
### Identifying and Providing default settings for the receiver ### Identifying and Providing default settings for the receiver
@ -1172,7 +1173,7 @@ pipeline and is now instantiating it and starting it given that 1 minute after
the Collector has started, you can see the info line we added to the `ticker` the Collector has started, you can see the info line we added to the `ticker`
function within the `Start()` method. function within the `Start()` method.
Now, go ahead and press <kbd>Control+C</kbd> in your Collector's terminal so you Now, go ahead and press <kbd>Ctrl + C</kbd> in your Collector's terminal so you
want watch the shutdown process happening. Here is what the output should look want watch the shutdown process happening. Here is what the output should look
like: like:

View File

@ -28,8 +28,8 @@ the automatic instrumentation agent does exactly the same thing as manual
instrumentation. instrumentation.
Automatic instrumentation utilizes [monkey-patching][] to dynamically rewrite Automatic instrumentation utilizes [monkey-patching][] to dynamically rewrite
methods and classes at runtime through [instrumentation methods and classes at runtime through [instrumentation libraries][instrumentation].
libraries][instrumentation]. This reduces the amount of work required to This reduces the amount of work required to
integrate OpenTelemetry into your application code. Below, you will see the integrate OpenTelemetry into your application code. Below, you will see the
difference between a Flask route instrumented manually versus one that utilizes difference between a Flask route instrumented manually versus one that utilizes
automatic instrumentation. automatic instrumentation.
@ -168,7 +168,7 @@ example:
### Execute an automatically instrumented server ### Execute an automatically instrumented server
Stop the execution of `server_instrumented.py` by pressing <kbd>Control+C</kbd> Stop the execution of `server_instrumented.py` by pressing <kbd>Ctrl + C</kbd>
and run the following command instead: and run the following command instead:
```console ```console
@ -297,8 +297,7 @@ If those headers are available, they will be included in your span:
} }
``` ```
[semantic convention]: [semantic convention]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#http-request-and-response-headers
https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/http.md#http-request-and-response-headers
[API reference]: https://opentelemetry-python.readthedocs.io/en/latest/index.html [API reference]: https://opentelemetry-python.readthedocs.io/en/latest/index.html
[distro]: https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/opentelemetry-distro [distro]: https://github.com/open-telemetry/opentelemetry-python-contrib/tree/main/opentelemetry-distro
[env]: https://opentelemetry-python.readthedocs.io/en/latest/sdk/environment_variables.html [env]: https://opentelemetry-python.readthedocs.io/en/latest/sdk/environment_variables.html