Skip to content

Commit

Permalink
Merge branch 'main' of github.com:open-telemetry/opentelemetry.io int…
Browse files Browse the repository at this point in the history
…o jmacd/otelarrowprod
  • Loading branch information
jmacd committed Sep 18, 2024
2 parents 5516e16 + 7934afd commit ea57cd3
Show file tree
Hide file tree
Showing 96 changed files with 2,380 additions and 1,817 deletions.
1 change: 1 addition & 0 deletions .cspell/en-words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ jaeger
jaegertracing
javaagent
javadoc
javadocs
jboss
jdbc
julia
Expand Down
2 changes: 1 addition & 1 deletion .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
[submodule "content-modules/opentelemetry-specification"]
path = content-modules/opentelemetry-specification
url = https://github.com/open-telemetry/opentelemetry-specification.git
spec-pin = v1.36.0
spec-pin = v1.37.0
[submodule "content-modules/community"]
path = content-modules/community
url = https://github.com/open-telemetry/community
Expand Down
2 changes: 1 addition & 1 deletion .htmltest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ IgnoreDirs:
- ^blog/(\d+/)?page/\d+
IgnoreInternalURLs: # list of paths
IgnoreURLs: # list of regexs of paths or URLs to be ignored
- ^(/..)?/docs/languages/\w+/(api|examples|registry)/$
- ^((/..)?/docs/languages/\w+|\.\.)/(api|examples|registry)/$
- ^(/..)?/docs/collector/registry/$
- ^(/..)?/docs/languages/net/(metrics-api|traces-api)/
- ^((/..)?/docs/migration/)?opencensus/$
Expand Down
1 change: 1 addition & 0 deletions .textlintrc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ rules:
- '(?<![.-])java\b(?![.])'
- Java
- ['java[- ]?agent', Java agent]
- ['java ?doc(s)?', 'Javadoc$1']
- [mac ?os, macOS]
- ['meta[- ]data', metadata]
- [nd-?json, NDJSON]
Expand Down
16 changes: 16 additions & 0 deletions content/en/api-docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: API Documentation
linkTitle: Docs
cSpell:ignore: apidocs
---

{{% blocks/section color="white" %}}

## {{% param title %}}

Below you will find links to all the API references available for the different
implementations of the OpenTelemetry API & SDK

{{% apidocs %}}

{{% /blocks/section %}}
52 changes: 31 additions & 21 deletions content/en/docs/collector/internal-telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,18 +23,24 @@ By default, the Collector exposes its own telemetry in two ways:

You can configure how internal metrics are generated and exposed by the
Collector. By default, the Collector generates basic metrics about itself and
exposes them for scraping at `http://127.0.0.1:8888/metrics`. You can expose the
endpoint to one specific or all network interfaces when needed. For
containerized environments, you might want to expose this port on a public
interface.
exposes them using the OpenTelemetry Go
[Prometheus exporter](https://github.com/open-telemetry/opentelemetry-go/tree/main/exporters/prometheus)
for scraping at `http://127.0.0.1:8888/metrics`. You can expose the endpoint to
one specific or all network interfaces when needed. For containerized
environments, you might want to expose this port on a public interface.

Set the address in the config `service::telemetry::metrics`:
Set the Prometheus config under `service::telemetry::metrics`:

```yaml
service:
telemetry:
metrics:
address: 0.0.0.0:8888
readers:
pull:
exporter:
prometheus:
host: '0.0.0.0'
port: 8888
```
You can adjust the verbosity of the Collector metrics output by setting the
Expand All @@ -59,30 +65,34 @@ service:
level: detailed
```

The Collector can also be configured to scrape its own metrics using a
[Prometheus receiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/prometheusreceiver)
and send them through configured pipelines. For example:
The Collector can also be configured to push its own metrics to an
[OTLP receiver](https://github.com/open-telemetry/opentelemetry-collector/tree/main/receiver/otlpreceiver)
and send them through configured pipelines. In the following example, the
Collector is configured to push metrics every 10s using OTLP gRPC to
`localhost:14317`:

```yaml
receivers:
prometheus:
config:
scrape_configs:
- job_name: 'otelcol'
scrape_interval: 10s
static_configs:
- targets: ['0.0.0.0:8888']
metric_relabel_configs:
- source_labels: [__name__]
regex: '.*grpc_io.*'
action: drop
otlp/internal_metrics:
protocols:
grpc:
endpoint: localhost:14317
exporters:
debug:
service:
pipelines:
metrics:
receivers: [prometheus]
receivers: [otlp/internal_metrics]
exporters: [debug]
telemetry:
metrics:
readers:
- periodic:
interval: 10000
exporter:
otlp:
protocol: grpc/protobuf
endpoint: localhost:14317
```

{{% alert title="Caution" color="warning" %}}
Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/collector/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ preferred shell.

## Set up the environment

1. Pull in the OpenTelemetry Collector Docker image:
1. Pull in the OpenTelemetry Collector Contrib Docker image:

```sh
docker pull otel/opentelemetry-collector:{{% param vers %}}
docker pull otel/opentelemetry-collector-contrib:{{% param vers %}}
```

2. Install the [telemetrygen] utility:
Expand All @@ -63,7 +63,7 @@ preferred shell.
docker run \
-p 127.0.0.1:4317:4317 \
-p 127.0.0.1:55679:55679 \
otel/opentelemetry-collector:{{% param vers %}} \
otel/opentelemetry-collector-contrib:{{% param vers %}} \
2>&1 | tee collector-output.txt # Optionally tee output for easier search later
```

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/concepts/sampling/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ as possible. A decision to sample or drop a span or trace is not made by
inspecting the trace as a whole.

For example, the most common form of head sampling is
[Consistent Probability Sampling](/docs/specs/otel/trace/tracestate-probability-sampling/#consistent-probability-sampling).
[Consistent Probability Sampling](/docs/specs/otel/trace/tracestate-probability-sampling-experimental/#consistent-probability-sampling).
This is also be referred to as Deterministic Sampling. In this case, a sampling
decision is made based on the trace ID and the desired percentage of traces to
sample. This ensures that whole traces are sampled - no missing spans - at a
Expand Down
3 changes: 2 additions & 1 deletion content/en/docs/languages/java/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,9 @@ description: >-
aliases: [/java, /java/metrics, /java/tracing]
cascade:
vers:
instrumentation: 2.7.0
instrumentation: 2.8.0
otel: 1.42.1
contrib: 1.38.0
semconv: 1.27.0
weight: 18
---
Expand Down
Loading

0 comments on commit ea57cd3

Please sign in to comment.