Skip to content

Commit ab5ffed

Browse files
psx95psx95
authored
Merge branch 'main' into update-registry-auth-extension
2 parents 1489fbd + 7d0c3f2 commit ab5ffed

18 files changed

+987
-71
lines changed

‎content/en/docs/collector/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Collector
33
description: Vendor-agnostic way to receive, process and export telemetry data.
44
aliases: [./about]
55
cascade:
6-
vers: 0.122.0
6+
vers: 0.122.1
77
weight: 270
88
---
99

‎content/en/docs/collector/internal-telemetry.md

+48-34
Original file line numberDiff line numberDiff line change
@@ -238,43 +238,57 @@ files in the repository.
238238

239239
#### `basic`-level metrics
240240

241-
| Metric name | Description | Type |
242-
| ------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------- |
243-
| `otelcol_exporter_enqueue_failed_`<br>`log_records` | Number of logs that exporter(s) failed to enqueue. | Counter |
244-
| `otelcol_exporter_enqueue_failed_`<br>`metric_points` | Number of metric points that exporter(s) failed to enqueue. | Counter |
245-
| `otelcol_exporter_enqueue_failed_`<br>`spans` | Number of spans that exporter(s) failed to enqueue. | Counter |
246-
| `otelcol_exporter_queue_capacity` | Fixed capacity of the sending queue, in batches. | Gauge |
247-
| `otelcol_exporter_queue_size` | Current size of the sending queue, in batches. | Gauge |
248-
| `otelcol_exporter_send_failed_`<br>`log_records` | Number of logs that exporter(s) failed to send to destination. | Counter |
249-
| `otelcol_exporter_send_failed_`<br>`metric_points` | Number of metric points that exporter(s) failed to send to destination. | Counter |
250-
| `otelcol_exporter_send_failed_`<br>`spans` | Number of spans that exporter(s) failed to send to destination. | Counter |
251-
| `otelcol_exporter_sent_log_records` | Number of logs successfully sent to destination. | Counter |
252-
| `otelcol_exporter_sent_metric_points` | Number of metric points successfully sent to destination. | Counter |
253-
| `otelcol_exporter_sent_spans` | Number of spans successfully sent to destination. | Counter |
254-
| `otelcol_process_cpu_seconds` | Total CPU user and system time in seconds. | Counter |
255-
| `otelcol_process_memory_rss` | Total physical memory (resident set size) in bytes. | Gauge |
256-
| `otelcol_process_runtime_heap_`<br>`alloc_bytes` | Bytes of allocated heap objects (see 'go doc runtime.MemStats.HeapAlloc'). | Gauge |
257-
| `otelcol_process_runtime_total_`<br>`alloc_bytes` | Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc'). | Counter |
258-
| `otelcol_process_runtime_total_`<br>`sys_memory_bytes` | Total bytes of memory obtained from the OS (see 'go doc runtime.MemStats.Sys'). | Gauge |
259-
| `otelcol_process_uptime` | Uptime of the process in seconds. | Counter |
260-
| `otelcol_processor_batch_batch_`<br>`send_size` | Number of units in the batch that was sent. | Histogram |
261-
| `otelcol_processor_batch_batch_size_`<br>`trigger_send` | Number of times the batch was sent due to a size trigger. | Counter |
262-
| `otelcol_processor_batch_metadata_`<br>`cardinality` | Number of distinct metadata value combinations being processed. | Counter |
263-
| `otelcol_processor_batch_timeout_`<br>`trigger_send` | Number of times the batch was sent due to a timeout trigger. | Counter |
264-
| `otelcol_processor_incoming_items` | Number of items passed to the processor. | Counter |
265-
| `otelcol_processor_outgoing_items` | Number of items emitted from the processor. | Counter |
266-
| `otelcol_receiver_accepted_`<br>`log_records` | Number of logs successfully ingested and pushed into the pipeline. | Counter |
267-
| `otelcol_receiver_accepted_`<br>`metric_points` | Number of metric points successfully ingested and pushed into the pipeline. | Counter |
268-
| `otelcol_receiver_accepted_spans` | Number of spans successfully ingested and pushed into the pipeline. | Counter |
269-
| `otelcol_receiver_refused_`<br>`log_records` | Number of logs that could not be pushed into the pipeline. | Counter |
270-
| `otelcol_receiver_refused_`<br>`metric_points` | Number of metric points that could not be pushed into the pipeline. | Counter |
271-
| `otelcol_receiver_refused_spans` | Number of spans that could not be pushed into the pipeline. | Counter |
272-
| `otelcol_scraper_errored_`<br>`metric_points` | Number of metric points the Collector failed to scrape. | Counter |
273-
| `otelcol_scraper_scraped_`<br>`metric_points` | Number of metric points scraped by the Collector. | Counter |
241+
| Metric name | Description | Type |
242+
| ------------------------------------------------------ | --------------------------------------------------------------------------------------- | ------- |
243+
| `otelcol_exporter_enqueue_failed_`<br>`log_records` | Number of logs that exporter(s) failed to enqueue. | Counter |
244+
| `otelcol_exporter_enqueue_failed_`<br>`metric_points` | Number of metric points that exporter(s) failed to enqueue. | Counter |
245+
| `otelcol_exporter_enqueue_failed_`<br>`spans` | Number of spans that exporter(s) failed to enqueue. | Counter |
246+
| `otelcol_exporter_queue_capacity` | Fixed capacity of the sending queue, in batches. | Gauge |
247+
| `otelcol_exporter_queue_size` | Current size of the sending queue, in batches. | Gauge |
248+
| `otelcol_exporter_send_failed_`<br>`log_records` | Number of logs that exporter(s) failed to send to destination. | Counter |
249+
| `otelcol_exporter_send_failed_`<br>`metric_points` | Number of metric points that exporter(s) failed to send to destination. | Counter |
250+
| `otelcol_exporter_send_failed_`<br>`spans` | Number of spans that exporter(s) failed to send to destination. | Counter |
251+
| `otelcol_exporter_sent_log_records` | Number of logs successfully sent to destination. | Counter |
252+
| `otelcol_exporter_sent_metric_points` | Number of metric points successfully sent to destination. | Counter |
253+
| `otelcol_exporter_sent_spans` | Number of spans successfully sent to destination. | Counter |
254+
| `otelcol_process_cpu_seconds` | Total CPU user and system time in seconds. | Counter |
255+
| `otelcol_process_memory_rss` | Total physical memory (resident set size) in bytes. | Gauge |
256+
| `otelcol_process_runtime_heap_`<br>`alloc_bytes` | Bytes of allocated heap objects (see 'go doc runtime.MemStats.HeapAlloc'). | Gauge |
257+
| `otelcol_process_runtime_total_`<br>`alloc_bytes` | Cumulative bytes allocated for heap objects (see 'go doc runtime.MemStats.TotalAlloc'). | Counter |
258+
| `otelcol_process_runtime_total_`<br>`sys_memory_bytes` | Total bytes of memory obtained from the OS (see 'go doc runtime.MemStats.Sys'). | Gauge |
259+
| `otelcol_process_uptime` | Uptime of the process in seconds. | Counter |
260+
| `otelcol_processor_incoming_items` | Number of items passed to the processor. | Counter |
261+
| `otelcol_processor_outgoing_items` | Number of items emitted from the processor. | Counter |
262+
| `otelcol_receiver_accepted_`<br>`log_records` | Number of logs successfully ingested and pushed into the pipeline. | Counter |
263+
| `otelcol_receiver_accepted_`<br>`metric_points` | Number of metric points successfully ingested and pushed into the pipeline. | Counter |
264+
| `otelcol_receiver_accepted_spans` | Number of spans successfully ingested and pushed into the pipeline. | Counter |
265+
| `otelcol_receiver_refused_`<br>`log_records` | Number of logs that could not be pushed into the pipeline. | Counter |
266+
| `otelcol_receiver_refused_`<br>`metric_points` | Number of metric points that could not be pushed into the pipeline. | Counter |
267+
| `otelcol_receiver_refused_spans` | Number of spans that could not be pushed into the pipeline. | Counter |
268+
| `otelcol_scraper_errored_`<br>`metric_points` | Number of metric points the Collector failed to scrape. | Counter |
269+
| `otelcol_scraper_scraped_`<br>`metric_points` | Number of metric points scraped by the Collector. | Counter |
274270

275271
#### Additional `normal`-level metrics
276272

277-
There are currently no metrics specific to `normal` verbosity.
273+
| Metric name | Description | Type |
274+
| ------------------------------------------------------- | --------------------------------------------------------------- | --------- |
275+
| `otelcol_processor_batch_batch_`<br>`send_size` | Number of units in the batch that was sent. | Histogram |
276+
| `otelcol_processor_batch_batch_size_`<br>`trigger_send` | Number of times the batch was sent due to a size trigger. | Counter |
277+
| `otelcol_processor_batch_metadata_`<br>`cardinality` | Number of distinct metadata value combinations being processed. | Counter |
278+
| `otelcol_processor_batch_timeout_`<br>`trigger_send` | Number of times the batch was sent due to a timeout trigger. | Counter |
279+
280+
{{% alert title="Batch processor metrics level changes" color="info" %}}
281+
282+
In Collector [v0.99.0], all batch processor metrics were upgraded from `basic`
283+
to `normal` (current level), except for
284+
`otelcol_processor_batch_batch_send_size_bytes`, which has been `detailed` since
285+
its introduction. Note however that these metrics were inadvertently reverted to
286+
`basic` from v0.109.0 to v0.121.0.
287+
288+
[v0.99.0]:
289+
https://github.com/open-telemetry/opentelemetry-collector/releases/tag/v0.99.0
290+
291+
{{% /alert %}}
278292

279293
#### Additional `detailed`-level metrics
280294

‎layouts/shortcodes/docs/languages/exporters/jaeger.md ‎content/en/docs/languages/_includes/exporters/jaeger.md

File renamed without changes.

‎layouts/shortcodes/docs/languages/exporters/outro.md ‎content/en/docs/languages/_includes/exporters/outro.md

+1-6
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
1-
{{ $lang := .Get 0 -}} {{ $spanExporterInterfaceUrl := .Get 1 }}
2-
31
## Custom exporters
42

53
Finally, you can also write your own exporter. For more information, see the
6-
[SpanExporter Interface in the API
7-
documentation]({{ $spanExporterInterfaceUrl }}).
4+
[SpanExporter Interface in the API documentation]({{ $1 }}).
85

96
## Batching span and log records
107

118
The OpenTelemetry SDK provides a set of default span and log record processors,
129
that allow you to either emit spans one-by-on ("simple") or batched. Using
1310
batching is recommended, but if you do not want to batch your spans or log
1411
records, you can use a simple processor instead as follows:
15-
16-
{{ .Inner }}

‎layouts/shortcodes/docs/languages/exporters/prometheus-setup.md ‎content/en/docs/languages/_includes/exporters/prometheus-setup.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ Prometheus text format on request.
88

99
### Backend Setup {#prometheus-setup}
1010

11-
<div class="alert alert-info" role="alert"><h4 class="alert-heading">Note</h4>
11+
{{% alert-md title=Note color=info %}}
1212

1313
If you have Prometheus or a Prometheus-compatible backend already set up, you
1414
can skip this section and setup the [Prometheus](#prometheus-dependencies) or
1515
[OTLP](#otlp-dependencies) exporter dependencies for your application.
1616

17-
</div>
17+
{{% /alert-md %}}
1818

1919
You can run [Prometheus](https://prometheus.io) in a docker container,
2020
accessible on port `9090` by following these instructions:
@@ -35,7 +35,7 @@ Run Prometheus in a docker container with the UI accessible on port `9090`:
3535
docker run --rm -v ${PWD}/prometheus.yml:/prometheus/prometheus.yml -p 9090:9090 prom/prometheus --enable-feature=otlp-write-receive
3636
```
3737

38-
<div class="alert alert-info" role="alert"><h4 class="alert-heading">Note</h4>
38+
{{% alert-md title=Note color=info %}}
3939

4040
When using Prometheus' OTLP Receiver, make sure that you set the OTLP endpoint
4141
for metrics in your application to `http://localhost:9090/api/v1/otlp`.
@@ -44,4 +44,4 @@ Not all docker environments support `host.docker.internal`. In some cases you
4444
may need to replace `host.docker.internal` with `localhost` or the IP address of
4545
your machine.
4646

47-
</div>
47+
{{% /alert-md %}}

‎layouts/shortcodes/docs/languages/exporters/zipkin-setup.md ‎content/en/docs/languages/_includes/exporters/zipkin-setup.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,13 @@
22

33
### Backend Setup {#zipkin-setup}
44

5-
<div class="alert alert-info" role="alert"><h4 class="alert-heading">Note</h4>
5+
{{% alert-md title=Note color=info %}}
66

77
If you have Zipkin or a Zipkin-compatible backend already set up, you can skip
88
this section and setup the [Zipkin exporter dependencies](#zipkin-dependencies)
99
for your application.
1010

11-
</div>
11+
{{% /alert-md %}}
1212

1313
You can run [Zipkin](https://zipkin.io/) on in a Docker container by executing
1414
the following command:

‎content/en/docs/languages/cpp/exporters.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -265,9 +265,9 @@ void InitLogger()
265265
}
266266
```
267267
268-
{{% docs/languages/exporters/jaeger %}}
268+
{{% include "exporters/jaeger.md" %}}
269269
270-
{{% docs/languages/exporters/prometheus-setup %}}
270+
{{% include "exporters/prometheus-setup.md" %}}
271271
272272
### Dependencies {#prometheus-dependencies}
273273
@@ -310,7 +310,7 @@ With the above you can access your metrics at <http://localhost:9464/metrics>.
310310
Prometheus or an OpenTelemetry Collector with the Prometheus receiver can scrape
311311
the metrics from this endpoint.
312312
313-
{{% docs/languages/exporters/zipkin-setup %}}
313+
{{% include "exporters/zipkin-setup.md" %}}
314314
315315
### Dependencies {#zipkin-dependencies}
316316
@@ -353,7 +353,7 @@ void InitTracer()
353353
}
354354
```
355355
356-
{{% docs/languages/exporters/outro python `https://opentelemetry-cpp.readthedocs.io/en/latest/otel_docs/classopentelemetry_1_1sdk_1_1trace_1_1SpanExporter.html` %}}
356+
{{% include "exporters/outro.md" `https://opentelemetry-cpp.readthedocs.io/en/latest/otel_docs/classopentelemetry_1_1sdk_1_1trace_1_1SpanExporter.html` %}}
357357
358358
{{< tabpane text=true >}} {{% tab Batch %}}
359359
@@ -383,5 +383,3 @@ auto processor = opentelemetry::sdk::trace::SimpleSpanProcessorFactory::Create(s
383383
```
384384

385385
{{< /tab >}} {{< /tabpane>}}
386-
387-
{{% /docs/languages/exporters/outro %}}

‎content/en/docs/languages/js/exporters.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -239,9 +239,9 @@ package and the `ConsoleMetricExporter` is included in the
239239
[`@opentelemetry/sdk-metrics`](https://www.npmjs.com/package/@opentelemetry/sdk-metrics)
240240
package:
241241

242-
{{% docs/languages/exporters/jaeger %}}
242+
{{% include "exporters/jaeger.md" %}}
243243

244-
{{% docs/languages/exporters/prometheus-setup %}}
244+
{{% include "exporters/prometheus-setup.md" %}}
245245

246246
### Dependencies {#prometheus-dependencies}
247247

@@ -296,7 +296,7 @@ With the above you can access your metrics at <http://localhost:9464/metrics>.
296296
Prometheus or an OpenTelemetry Collector with the Prometheus receiver can scrape
297297
the metrics from this endpoint.
298298

299-
{{% docs/languages/exporters/zipkin-setup %}}
299+
{{% include "exporters/zipkin-setup.md" %}}
300300

301301
### Dependencies {#zipkin-dependencies}
302302

@@ -345,7 +345,7 @@ const sdk = new opentelemetry.NodeSDK({
345345

346346
{{% /tab %}} {{< /tabpane >}}
347347

348-
{{% docs/languages/exporters/outro js `https://open-telemetry.github.io/opentelemetry-js/interfaces/_opentelemetry_sdk_trace_base.SpanExporter.html` %}}
348+
{{% include "exporters/outro.md" `https://open-telemetry.github.io/opentelemetry-js/interfaces/_opentelemetry_sdk_trace_base.SpanExporter.html` %}}
349349

350350
{{< tabpane text=true >}} {{% tab TypeScript %}}
351351

@@ -379,8 +379,6 @@ sdk.start();
379379

380380
{{% /tab %}} {{< /tabpane >}}
381381

382-
{{% /docs/languages/exporters/outro %}}
383-
384382
[content security policies]:
385383
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/
386384
[cross-origin resource sharing]:

‎content/en/docs/languages/net/exporters.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -198,9 +198,9 @@ var loggerFactory = LoggerFactory.Create(builder =>
198198
});
199199
```
200200

201-
{{% docs/languages/exporters/jaeger %}}
201+
{{% include "exporters/jaeger.md" %}}
202202

203-
{{% docs/languages/exporters/prometheus-setup %}}
203+
{{% include "exporters/prometheus-setup.md" %}}
204204

205205
### Dependencies {#prometheus-dependencies}
206206

@@ -292,7 +292,7 @@ app.UseOpenTelemetryPrometheusScrapingEndpoint();
292292
Further details on configuring the Prometheus exporter can be found
293293
[here](https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Exporter.Prometheus.AspNetCore/README.md).
294294

295-
{{% docs/languages/exporters/zipkin-setup %}}
295+
{{% include "exporters/zipkin-setup.md" %}}
296296

297297
### Dependencies {#zipkin-dependencies}
298298

‎content/en/docs/languages/python/exporters.md

+4-6
Original file line numberDiff line numberDiff line change
@@ -190,9 +190,9 @@ variable to `CUMULATIVE`.
190190

191191
{{% /alert %}}
192192

193-
{{% docs/languages/exporters/jaeger %}}
193+
{{% include "exporters/jaeger.md" %}}
194194

195-
{{% docs/languages/exporters/prometheus-setup %}}
195+
{{% include "exporters/prometheus-setup.md" %}}
196196

197197
### Dependencies {#prometheus-dependencies}
198198

@@ -233,7 +233,7 @@ With the above you can access your metrics at <http://localhost:9464/metrics>.
233233
Prometheus or an OpenTelemetry Collector with the Prometheus receiver can scrape
234234
the metrics from this endpoint.
235235

236-
{{% docs/languages/exporters/zipkin-setup %}}
236+
{{% include "exporters/zipkin-setup.md" %}}
237237

238238
### Dependencies {#zipkin-dependencies}
239239

@@ -306,13 +306,11 @@ trace.set_tracer_provider(provider)
306306

307307
{{% /tab %}} {{< /tabpane >}}
308308

309-
{{% docs/languages/exporters/outro python `https://opentelemetry-python.readthedocs.io/en/latest/sdk/trace.export.html#opentelemetry.sdk.trace.export.SpanExporter` %}}
309+
{{% include "exporters/outro.md" `https://opentelemetry-python.readthedocs.io/en/latest/sdk/trace.export.html#opentelemetry.sdk.trace.export.SpanExporter` %}}
310310

311311
```python
312312
from opentelemetry.exporter.otlp.proto.grpc.trace_exporter import OTLPSpanExporter
313313
from opentelemetry.sdk.trace.export import SimpleSpanProcessor
314314

315315
processor = SimpleSpanProcessor(OTLPSpanExporter(endpoint="your-endpoint-here"))
316316
```
317-
318-
{{% /docs/languages/exporters/outro %}}

‎content/en/docs/security/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Security
33
cascade:
4-
collector_vers: 0.122.0
4+
collector_vers: 0.122.1
55
weight: 970
66
---
77

0 commit comments

Comments
 (0)