Skip to content

Commit 1d8b1c3

Browse files
committed
Updated to support v0.111 of otelcol-contrib
1 parent 3046663 commit 1d8b1c3

File tree

17 files changed

+165
-98
lines changed

17 files changed

+165
-98
lines changed

content/en/ninja-workshops/3-opentelemetry-collector/1-installation/1-confirmation.md

Lines changed: 36 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -21,24 +21,24 @@ sudo systemctl status otelcol-contrib
2121
``` text
2222
● otelcol-contrib.service - OpenTelemetry Collector Contrib
2323
Loaded: loaded (/lib/systemd/system/otelcol-contrib.service; enabled; vendor preset: enabled)
24-
Active: active (running) since Tue 2023-05-16 08:23:23 UTC; 25s ago
25-
Main PID: 1415 (otelcol-contrib)
26-
Tasks: 5 (limit: 1141)
27-
Memory: 22.2M
28-
CPU: 125ms
24+
Active: active (running) since Mon 2024-10-07 10:27:49 BST; 52s ago
25+
Main PID: 17113 (otelcol-contrib)
26+
Tasks: 13 (limit: 19238)
27+
Memory: 34.8M
28+
CPU: 155ms
2929
CGroup: /system.slice/otelcol-contrib.service
30-
└─1415 /usr/bin/otelcol-contrib --config=/etc/otelcol-contrib/config.yaml
31-
32-
May 16 08:23:39 ip-10-0-9-125 otelcol-contrib[1415]: NumberDataPoints #0
33-
May 16 08:23:39 ip-10-0-9-125 otelcol-contrib[1415]: Data point attributes:
34-
May 16 08:23:39 ip-10-0-9-125 otelcol-contrib[1415]: -> exporter: Str(logging)
35-
May 16 08:23:39 ip-10-0-9-125 otelcol-contrib[1415]: -> service_instance_id: Str(df8a57f4-abdc-46b9-a847-acd62db1001f)
36-
May 16 08:23:39 ip-10-0-9-125 otelcol-contrib[1415]: -> service_name: Str(otelcol-contrib)
37-
May 16 08:23:39 ip-10-0-9-125 otelcol-contrib[1415]: -> service_version: Str(0.75.0)
38-
May 16 08:23:39 ip-10-0-9-125 otelcol-contrib[1415]: StartTimestamp: 2023-05-16 08:23:39.006 +0000 UTC
39-
May 16 08:23:39 ip-10-0-9-125 otelcol-contrib[1415]: Timestamp: 2023-05-16 08:23:39.006 +0000 UTC
40-
May 16 08:23:39 ip-10-0-9-125 otelcol-contrib[1415]: Value: 0.000000
41-
May 16 08:23:39 ip-10-0-9-125 otelcol-contrib[1415]: {"kind": "exporter", "data_type": "metrics", "name": "logging"}
30+
└─17113 /usr/bin/otelcol-contrib --config=/etc/otelcol-contrib/config.yaml
31+
32+
Oct 07 10:28:36 petclinic-rum-testing otelcol-contrib[17113]: Descriptor:
33+
Oct 07 10:28:36 petclinic-rum-testing otelcol-contrib[17113]: -> Name: up
34+
Oct 07 10:28:36 petclinic-rum-testing otelcol-contrib[17113]: -> Description: The scraping was successful
35+
Oct 07 10:28:36 petclinic-rum-testing otelcol-contrib[17113]: -> Unit:
36+
Oct 07 10:28:36 petclinic-rum-testing otelcol-contrib[17113]: -> DataType: Gauge
37+
Oct 07 10:28:36 petclinic-rum-testing otelcol-contrib[17113]: NumberDataPoints #0
38+
Oct 07 10:28:36 petclinic-rum-testing otelcol-contrib[17113]: StartTimestamp: 1970-01-01 00:00:00 +0000 UTC
39+
Oct 07 10:28:36 petclinic-rum-testing otelcol-contrib[17113]: Timestamp: 2024-10-07 09:28:36.942 +0000 UTC
40+
Oct 07 10:28:36 petclinic-rum-testing otelcol-contrib[17113]: Value: 1.000000
41+
Oct 07 10:28:36 petclinic-rum-testing otelcol-contrib[17113]: {"kind": "exporter", "data_type": "metrics", "name": "debug"}
4242
```
4343

4444
{{% /tab %}}
@@ -221,6 +221,9 @@ cat /etc/otelcol-contrib/config.yaml
221221
{{% tab title="config.yaml" %}}
222222

223223
```yaml { lineNos="table" wrap="true"}
224+
# To limit exposure to denial of service attacks, change the host in endpoints below from 0.0.0.0 to a specific network interface.
225+
# See https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/security-best-practices.md#safeguards-against-denial-of-service-attacks
226+
224227
extensions:
225228
health_check:
226229
pprof:
@@ -232,9 +235,12 @@ receivers:
232235
otlp:
233236
protocols:
234237
grpc:
238+
endpoint: 0.0.0.0:4317
235239
http:
240+
endpoint: 0.0.0.0:4318
236241
237242
opencensus:
243+
endpoint: 0.0.0.0:55678
238244
239245
# Collect own metrics
240246
prometheus:
@@ -248,17 +254,22 @@ receivers:
248254
jaeger:
249255
protocols:
250256
grpc:
257+
endpoint: 0.0.0.0:14250
251258
thrift_binary:
259+
endpoint: 0.0.0.0:6832
252260
thrift_compact:
261+
endpoint: 0.0.0.0:6831
253262
thrift_http:
263+
endpoint: 0.0.0.0:14268
254264
255265
zipkin:
266+
endpoint: 0.0.0.0:9411
256267
257268
processors:
258269
batch:
259270
260271
exporters:
261-
logging:
272+
debug:
262273
verbosity: detailed
263274
264275
service:
@@ -268,12 +279,17 @@ service:
268279
traces:
269280
receivers: [otlp, opencensus, jaeger, zipkin]
270281
processors: [batch]
271-
exporters: [logging]
282+
exporters: [debug]
272283
273284
metrics:
274285
receivers: [otlp, opencensus, prometheus]
275286
processors: [batch]
276-
exporters: [logging]
287+
exporters: [debug]
288+
289+
logs:
290+
receivers: [otlp]
291+
processors: [batch]
292+
exporters: [debug]
277293
278294
extensions: [health_check, pprof, zpages]
279295
```

content/en/ninja-workshops/3-opentelemetry-collector/1-installation/_index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The first step in installing the Open Telemetry Collector is downloading it. For
1111
Obtain the `.deb` package for your platform from the [**OpenTelemetry Collector Contrib releases page**](https://github.com/open-telemetry/opentelemetry-collector-releases/releases)
1212

1313
``` bash
14-
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v0.96.0/otelcol-contrib_0.96.0_linux_amd64.deb
14+
wget https://github.com/open-telemetry/opentelemetry-collector-releases/releases/download/v0.111.0/otelcol-contrib_0.111.0_linux_amd64.deb
1515
```
1616

1717
## Install the OpenTelemetry Collector Contrib distribution
@@ -22,18 +22,18 @@ Install the `.deb` package using `dpkg`. Take a look at the **dpkg Output** tab
2222
{{% tab title="Install" %}}
2323

2424
``` bash
25-
sudo dpkg -i otelcol-contrib_0.96.0_linux_amd64.deb
25+
sudo dpkg -i otelcol-contrib_0.111.0_linux_amd64.deb
2626
```
2727

2828
{{% /tab %}}
2929
{{% tab title="dpkg Output" %}}
3030

3131
``` text
3232
Selecting previously unselected package otelcol-contrib.
33-
(Reading database ... 64218 files and directories currently installed.)
34-
Preparing to unpack otelcol-contrib_0.96.0_linux_amd64.deb ...
35-
Unpacking otelcol-contrib (0.96.0) ...
36-
Setting up otelcol-contrib (0.96.0) ...
33+
(Reading database ... 89232 files and directories currently installed.)
34+
Preparing to unpack otelcol-contrib_0.111.0_linux_amd64.deb ...
35+
Unpacking otelcol-contrib (0.111.0) ...
36+
Setting up otelcol-contrib (0.111.0) ...
3737
Created symlink /etc/systemd/system/multi-user.target.wants/otelcol-contrib.service → /lib/systemd/system/otelcol-contrib.service.
3838
```
3939

content/en/ninja-workshops/3-opentelemetry-collector/2-extensions/1-health.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ curl http://localhost:13133
5151
{{% tab title="curl Output" %}}
5252

5353
``` text
54-
{"status":"Server available","upSince":"2023-04-27T10:11:22.153295874+01:00","uptime":"16m24.684476004s"}
54+
{"status":"Server available","upSince":"2024-10-07T11:00:08.004685295+01:00","uptime":"12.56420005s"}
5555
```
5656

5757
{{% /tab %}}

content/en/ninja-workshops/3-opentelemetry-collector/2-extensions/3-zpages.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ weight: 3
1313

1414
**ServiceZ** gives an overview of the collector services and quick access to the pipelinez, extensionz, and featurez zPages. The page also provides build and runtime information.
1515

16-
Example URL: [http://localhost:55679/debug/servicez](http://localhost:55679/debug/servicez) (change `localhost` to reflect your own environment).
16+
Example URL: [**http://localhost:55679/debug/servicez**](http://localhost:55679/debug/servicez) (change `localhost` to reflect your own environment).
1717

1818
![ServiceZ](../../images/servicez.png)
1919

@@ -22,7 +22,7 @@ Example URL: [http://localhost:55679/debug/servicez](http://localhost:55679/debu
2222

2323
**PipelineZ** provides insights on the running pipelines running in the collector. You can find information on type, if data is mutated, and you can also see information on the receivers, processors and exporters that are used for each pipeline.
2424

25-
Example URL: [http://localhost:55679/debug/pipelinez](http://localhost:55679/debug/pipelinez) (change `localhost` to reflect your own environment).
25+
Example URL: [**http://localhost:55679/debug/pipelinez**](http://localhost:55679/debug/pipelinez) (change `localhost` to reflect your own environment).
2626

2727
![PipelineZ](../../images/pipelinez.png)
2828

@@ -31,21 +31,13 @@ Example URL: [http://localhost:55679/debug/pipelinez](http://localhost:55679/deb
3131

3232
**ExtensionZ** shows the extensions that are active in the collector.
3333

34-
Example URL: [http://localhost:55679/debug/extensionz](http://localhost:55679/debug/extensionz) (change `localhost` to reflect your own environment).
34+
Example URL: [**http://localhost:55679/debug/extensionz**](http://localhost:55679/debug/extensionz) (change `localhost` to reflect your own environment).
3535

3636
![ExtensionZ](../../images/extensionz.png)
3737

3838
{{% /tab %}}
3939
{{% /tabs %}}
4040

41-
{{% notice style="info" %}}
42-
You can use your browser to access your environment emitting zPages information at (replace `<insert_your_ip>` with your IP address):
43-
44-
- **ServiceZ:** [http://<insert_your_ip>:55679/debug/servicez](http://<insert_your_ip>:55679/debug/servicez)
45-
- **PipelineZ:** [http://<insert_your_ip>:55679/debug/pipelinez](http://<insert_your_ip>:55679/debug/pipelinez)
46-
- **ExtensionZ:** [http://<insert_your_ip>:55679/debug/extensionz](http://<insert_your_ip>:55679/debug/extensionz)
47-
{{% /notice %}}
48-
4941
---
5042

5143
{{% expand title="{{% badge style=primary icon=user-ninja %}}**Ninja:** Improve data durability with storage extension{{% /badge %}}" %}}
@@ -286,7 +278,9 @@ Now that we've covered extensions, let's check our configuration changes.
286278
{{< tabs >}}
287279
{{% tab title="config.yaml" %}}
288280
289-
```yaml { lineNos="table" wrap="true" hl_lines="3" }
281+
```yaml { lineNos="table" wrap="true" hl_lines="5" }
282+
# See https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/security-best-practices.md#safeguards-against-denial-of-service-attacks
283+
290284
extensions:
291285
health_check:
292286
endpoint: 0.0.0.0:13133
@@ -299,9 +293,12 @@ receivers:
299293
otlp:
300294
protocols:
301295
grpc:
296+
endpoint: 0.0.0.0:4317
302297
http:
298+
endpoint: 0.0.0.0:4318
303299

304300
opencensus:
301+
endpoint: 0.0.0.0:55678
305302

306303
# Collect own metrics
307304
prometheus:
@@ -315,17 +312,22 @@ receivers:
315312
jaeger:
316313
protocols:
317314
grpc:
315+
endpoint: 0.0.0.0:14250
318316
thrift_binary:
317+
endpoint: 0.0.0.0:6832
319318
thrift_compact:
319+
endpoint: 0.0.0.0:6831
320320
thrift_http:
321+
endpoint: 0.0.0.0:14268
321322

322323
zipkin:
324+
endpoint: 0.0.0.0:9411
323325

324326
processors:
325327
batch:
326328

327329
exporters:
328-
logging:
330+
debug:
329331
verbosity: detailed
330332

331333
service:
@@ -335,12 +337,17 @@ service:
335337
traces:
336338
receivers: [otlp, opencensus, jaeger, zipkin]
337339
processors: [batch]
338-
exporters: [logging]
340+
exporters: [debug]
339341

340342
metrics:
341343
receivers: [otlp, opencensus, prometheus]
342344
processors: [batch]
343-
exporters: [logging]
345+
exporters: [debug]
346+
347+
logs:
348+
receivers: [otlp]
349+
processors: [batch]
350+
exporters: [debug]
344351

345352
extensions: [health_check, pprof, zpages]
346353
```
@@ -353,4 +360,4 @@ service:
353360
354361
Now that we have reviewed extensions, let's dive into the data pipeline portion of the workshop. A pipeline defines a path the data follows in the Collector starting from reception, moving to further processing or modification, and finally exiting the Collector via exporters.
355362
356-
The data pipeline in the OpenTelemetry Collector is made up of receivers, processors, and exporters. We will first start with receivers.
363+
The data pipeline in the OpenTelemetry Collector is made up of **receivers**, **processors**, and **exporters**. We will first start with receivers.

content/en/ninja-workshops/3-opentelemetry-collector/3-receivers/2-prometheus.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ prometheus/internal:
2626
2727
## Example Dashboard - Prometheus metrics
2828
29-
The following screenshot shows an example dashboard of spme of the metrics the Prometheus internal receiver collects from the OpenTelemetry Collector. Here, we can see accepted and sent spans, metrics and log records.
29+
The following screenshot shows an example dashboard of some of the metrics the Prometheus internal receiver collects from the OpenTelemetry Collector. Here, we can see accepted and sent spans, metrics and log records.
3030
3131
{{% notice style="note" %}}
3232
The following screenshot is an out-of-the-box (OOTB) dashboard from Splunk Observability Cloud that allows you to easily monitor your Splunk OpenTelemetry Collector install base.

content/en/ninja-workshops/3-opentelemetry-collector/3-receivers/3-other-receivers.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,10 @@ We've now covered receivers, so let's now check our configuration changes.
6262
{{< tabs >}}
6363
{{% tab title="config.yaml" %}}
6464
65-
```yaml {lineNos="table" wrap="true" hl_lines="10-30 39"}
65+
```yaml {lineNos="table" wrap="true" hl_lines="13-33 45"}
66+
# To limit exposure to denial of service attacks, change the host in endpoints below from 0.0.0.0 to a specific network interface.
67+
# See https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/security-best-practices.md#safeguards-against-denial-of-service-attacks
68+
6669
extensions:
6770
health_check:
6871
endpoint: 0.0.0.0:13133
@@ -96,9 +99,12 @@ receivers:
9699
otlp:
97100
protocols:
98101
grpc:
102+
endpoint: 0.0.0.0:4317
99103
http:
104+
endpoint: 0.0.0.0:4318
100105

101106
opencensus:
107+
endpoint: 0.0.0.0:55678
102108

103109
# Collect own metrics
104110
prometheus/internal:
@@ -112,17 +118,22 @@ receivers:
112118
jaeger:
113119
protocols:
114120
grpc:
121+
endpoint: 0.0.0.0:14250
115122
thrift_binary:
123+
endpoint: 0.0.0.0:6832
116124
thrift_compact:
125+
endpoint: 0.0.0.0:6831
117126
thrift_http:
127+
endpoint: 0.0.0.0:14268
118128

119129
zipkin:
130+
endpoint: 0.0.0.0:9411
120131

121132
processors:
122133
batch:
123134

124135
exporters:
125-
logging:
136+
debug:
126137
verbosity: detailed
127138

128139
service:
@@ -132,12 +143,17 @@ service:
132143
traces:
133144
receivers: [otlp, opencensus, jaeger, zipkin]
134145
processors: [batch]
135-
exporters: [logging]
146+
exporters: [debug]
136147

137148
metrics:
138-
receivers: [otlp, opencensus, prometheus/internal]
149+
receivers: [otlp, opencensus, prometheus]
150+
processors: [batch]
151+
exporters: [debug]
152+
153+
logs:
154+
receivers: [otlp]
139155
processors: [batch]
140-
exporters: [logging]
156+
exporters: [debug]
141157

142158
extensions: [health_check, pprof, zpages]
143159
```

0 commit comments

Comments
 (0)