Skip to content

Commit e13d6ca

Browse files
JV0812JV0812
committed
OYRM Troubleshooting doc
1 parent cc62513 commit e13d6ca

File tree

3 files changed

+127
-0
lines changed

3 files changed

+127
-0
lines changed

‎docs/send-data/opentelemetry-collector/remote-management/index.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,10 @@ In this section, we'll introduce the following concepts:
4444
<p>Discover how to apply processing rules for an OpenTelemetry agent using remote management source templates to enhance data handling.</p>
4545
</div>
4646
</div>
47+
<div className="box smallbox card">
48+
<div className="container">
49+
<a href="/docs/send-data/opentelemetry-collector/remote-management/troubleshooting"><img src={useBaseUrl('img/send-data/otel-color.svg')} alt="OTel thumbnail icon" width="25"/><h4>Troubleshooting</h4></a>
50+
<p>Find solutions to common issues with the OpenTelemetry remote management collector.</p>
51+
</div>
52+
</div>
4753
</div>

‎docs/send-data/opentelemetry-collector/remote-management/troubleshooting.md‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
---
2+
id: troubleshooting
3+
title: Troubleshooting
4+
description: Learn about common troubleshooting scenarios of Sumo Logic OpenTelemetry memote management.
5+
---
6+
7+
This document contains common troubleshooting scenarios about the Sumo Logic OpenTelemetry remote management collector.
8+
9+
## Source template specific issues
10+
11+
### Docker: Path Permission Denied
12+
13+
#### Error message
14+
15+
`
16+
Error: failed to setup configuration components: cannot start pipelines: permission denied while trying to connect to the Docker daemon socket at unix:///cav/run/docker.sock: Get "http://****>
17+
collector server run finished with error: failed to setup configuration components: cannot start pipelines: permission denied while trying to connect to the Docker daemon soc>
18+
`
19+
20+
#### Solution
21+
22+
1. Ensure that you have satisfied the [Docker source template pre-requisites](/docs/send-data/opentelemetry-collector/remote-management/source-templates/docker/#prerequisites).
23+
1. Restart the agent.
24+
25+
### Windows: Failed to apply OpAMP agent remote config
26+
27+
#### Error message
28+
29+
`
30+
Failed to start service: invalid configuration: no receiver configuration specified in config
31+
`
32+
33+
#### Solution
34+
35+
1. Make sure that you have selected the **Event Channels/Scrappers** suboptions for the source template config.
36+
2. Make sure that you have applied the **OpAMP** agent remote config.
37+
38+
### Apache: Missing hostname / Invalid hostname
39+
40+
#### Error message
41+
42+
`
43+
Failed to apply OpAMP agent remote config {"kind": "extension", "name": "opamp", "error": "cannot save the OpAMP effective config to /etc/otelcol-sumo/opamp.d: cannot validate config: receivers::apache/ce121f50-***nha-aidn: missing hostname: 'localhost'"}
44+
`
45+
46+
#### Solution
47+
48+
1. Ensure that you have satisfied the [Apache source template pre-requisites](/docs/send-data/opentelemetry-collector/remote-management/source-templates/apache/#prerequisites).
49+
1. Delete the invalid configuration from the machine path `/etc/otelcol-sumo/opamp.d`.
50+
1. Update the invalid inputs, delete invalid configuration source templates, or unlink the agent from UI.
51+
1. Restart the agent.
52+
53+
### Syslog: Failed to listen on interface
54+
55+
#### Error message
56+
57+
`
58+
Jan 17 11:34:14 ip-***-***-***-*** otelcol-sumo.sh[1234]: Error: failed to setup configuration components: cannot start pipelines: start stanza: failed to listen on interface: failed to configure tcp listener: listen tcp 0.0.0.0:***: bind: permission denied
59+
Jan 17 11:34:14 ip-***-***-***-*** otelcol-sumo.sh[1234]: 2025/01/17 11:34:14 collector server run finished with error: failed to setup configuration components: cannot start pipelines: start stanza: failed to listen on interface: failed to configure tcp listener: listen tcp 0.0.0.0:***: bind: permission denied
60+
`
61+
62+
#### Solution
63+
64+
1. Delete the invalid configuration from the machine path `/etc/otelcol-sumo/opamp.d`.
65+
1. Update the invalid inputs (Ensure that valid ports have the right permissions), delete invalid configuration source templates, or unlink the agent from UI.
66+
1. Restart the agent.
67+
68+
## Agent disconnected from opamp server
69+
70+
#### Error message
71+
72+
`
73+
Agent Health Warning on UI : agent disconnected from opamp server.
74+
`
75+
76+
#### Solution
77+
78+
- Restart the agent.
79+
80+
## Failed to apply OpAMP agent remote config
81+
82+
#### Error messages
83+
84+
Error message 1:
85+
86+
`
87+
Failed to apply OpAMP agent remote config {"kind": "extension", "name": "opamp", "error": "cannot save the OpAMP effective config to /etc/otelcol-sumo/opamp.d: cannot validate config: processors::filter/logs/5c4f1d86-7946-4174-952f-bb52f016d2cd: unable to parse OTTL condition \"IsMatch(body, \\\"~!@#$%^&*()_+{}|:\\\\\\\"<>?/.,';\\\\\\\\][=-`\\\")\": couldn't create function: the pattern supplied to IsMatch is not a valid regexp pattern: error parsing regexp: missing closing ]: [=-``"}
88+
`
89+
90+
Error message 2:
91+
92+
`
93+
collector server run finished with error: failed to setup configuration components: failed to build pipelines: failed to create "filelog/8ee0d9e8-92cf-46c8-97be-764c67e59a83" receiver for data type "logs": compile line end regex: error parsing regexp: unexpected
94+
`
95+
96+
#### Solution
97+
98+
1. Ensure the rules comply with [RE2 syntax](https://github.com/google/re2/wiki/Syntax).
99+
1. Delete the invalid configuration from the machine path `etc/otelcol-sumo/opamp.d`.
100+
1. Update the invalid inputs, delete invalid configuration source templates, or unlink the agent from UI. For example, replace the invalid regex with valid regex.
101+
102+
## Agent crashes completely
103+
104+
If there is a runtime error that leads the agent crash unexpectedly, follow the below steps to rectify the issue:
105+
106+
1. Delete the invalid configuration from the machine path `/etc/otelcol-sumo/opamp.d`.
107+
1. Update the invalid inputs, delete invalid configuration source templates, or unlink the agent from UI.
108+
1. Restart the agent.
109+
110+
## Agent stuck in the config processing loop
111+
112+
If the agent repeatedly fails to process the effective configuration, it will be unable to perform any other operations, including sending heartbeat signals to the server. The server may interpret the absence of these heartbeats as an indication that the agent is offline, which can complicate recovery efforts. To resolve this issue, follow the below-mentioned steps:
113+
114+
1. Delete the invalid configuration from the machine path `/etc/otelcol-sumo/opamp.d`.
115+
1. Update the invalid inputs, delete invalid configuration source templates, or unlink the agent from the user interface.
116+
1. Restart the agent.
117+
118+
## Agent sends failure response to the server
119+
120+
If the agent attempts to apply the effective configuration but encounters errors, such as incompatible or invalid configuration parameters, it will send a failure response to the Opamp server to indicate the problem. This issue, however, disrupts data ingestion and leads to service interruptions. To resolve this, you can update the invalid inputs, delete any invalid configuration source templates, or unlink the agent from the UI.

‎sidebars.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,7 @@ module.exports = {
257257
'send-data/opentelemetry-collector/remote-management/processing-rules/mask-rules-windows',
258258
],
259259
},
260+
'send-data/opentelemetry-collector/remote-management/troubleshooting',
260261
],
261262
},
262263
'send-data/opentelemetry-collector/auto-discovery',

0 commit comments

Comments
 (0)