You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/CONFIG.md
+12-38Lines changed: 12 additions & 38 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,8 @@
1
1
# Agent Control Configuration
2
2
3
-
Agent control will load the configuration from the file `config.yaml` in the corresponding directory (
4
-
`/etc/newrelic-agent-control` or `/opt/homebrew/var/lib/newrelic-agent-control`).
3
+
Agent control will load the configuration from the file `config.yaml` in the corresponding directory (`/etc/newrelic-agent-control` or `/opt/homebrew/var/lib/newrelic-agent-control`).
5
4
6
-
Additionally, any configuration field can be set as an environment variable with the `NR_AC` prefix, using `__` to
7
-
separate keys. Examples:
5
+
Additionally, any configuration field can be set as an environment variable with the `NR_AC` prefix, using `__` to separate keys. Examples:
The `chart_version` field is used to report the version of the helm chart used to upgrade Agent Control.
21
-
This is currently not set by fleet control, but it can be used already to perform tests.
22
-
This config is valid for K8s only, for on_host environments it will be ignored.
23
-
24
-
Example:
25
-
26
-
```yaml
27
-
chart_version: "0.99.0"
28
-
```
29
-
30
-
The behaviour if set locally is not defined yet.
31
-
32
16
### agents
33
17
34
-
List of agents configured locally. Check of [DEVELOPMENT](./DEVELOPMENT.md) for more information regarding agents and
35
-
their corresponding local configuration.
18
+
List of agents configured locally. Check of [DEVELOPMENT](./DEVELOPMENT.md) for more information regarding agents and their corresponding local configuration.
36
19
37
20
Example:
38
21
@@ -81,19 +64,14 @@ fleet_control:
81
64
82
65
### proxy
83
66
84
-
Agent Control will use the system proxy (configured through the standard `HTTP_PROXY` / `HTTPS_PROXY` environment
85
-
variables) but
86
-
proxy options can also be configured using the proxy configuration field. If both are set, the precedence works as
87
-
follows:
67
+
Agent Control will use the system proxy (configured through the standard `HTTP_PROXY` / `HTTPS_PROXY` environment variables) but
68
+
proxy options can also be configured using the proxy configuration field. If both are set, the precedence works as follows:
88
69
89
70
1. `proxy` configuration field
90
71
2. `HTTP_PROXY` environment variable
91
72
3. `HTTPS_PROXY` environment variable
92
73
93
-
⚠️ Proxy configuration is currently not compatible with fetching the certificate for signature validation. If you need
94
-
to setup a proxy you will need to either use a local certificate through
95
-
`fleet_control.signature_validation.certificate_pem_file_path`(recommended) or disable signature validation (highly
96
-
discouraged).
74
+
⚠️ Proxy configuration is currently not compatible with fetching the certificate for signature validation. If you need to setup a proxy you will need to either use a local certificate through `fleet_control.signature_validation.certificate_pem_file_path` (recommended) or disable signature validation (highly discouraged).
97
75
98
76
```yaml
99
77
proxy:
@@ -105,8 +83,7 @@ proxy:
105
83
106
84
### server
107
85
108
-
Agent Control status server allows consulting the status of Agent Control and any controlled agent. It can be configured
109
-
as follows:
86
+
Agent Control status server allows consulting the status of Agent Control and any controlled agent. It can be configured as follows:
110
87
111
88
```yaml
112
89
server:
@@ -126,17 +103,16 @@ health_check:
126
103
127
104
### self_instrumentation
128
105
129
-
Agent Control can be configured to instrument itself and report traces, logs and metrics through OpenTelemetry. If proxy
130
-
is configured globally it will also apply to self-instrumentation.
106
+
Agent Control can be configured to instrument itself and report traces, logs and metrics through OpenTelemetry. If proxy is configured globally it will also apply to self-instrumentation.
131
107
132
108
```yaml
133
109
self_instrumentation:
134
110
opentelemetry:
135
111
insecure_level: "newrelic_agent_control=info,off" # It is considered insecure because setting it up for external dependencies could potentially leak secrets. The default `newrelic_agent_control=debug,opamp_client=debug,off` disables external dependencies and can be considered secure.
136
112
endpoint: https://otlp.nr-data.net:4318 # HTTPS endpoint to report instrumentation to.
137
-
headers: {} # Headers that will be included in any request to the endpoint
113
+
headers: {} # Headers that will be included in any request to the endpoint
138
114
client_timeout: 10s# Timeout for performing requests, defaults to 30s.
139
-
custom_attributes: {} # Attributes to be decorated in all metrics, traces and logs
115
+
custom_attributes: {} # Attributes to be decorated in all metrics, traces and logs
140
116
metrics:
141
117
enabled: true # Defaults to false.
142
118
interval: 120s# Interval to report metrics, it defaults to 60s.
@@ -154,8 +130,7 @@ self_instrumentation:
154
130
155
131
### host_id
156
132
157
-
If the `host_id` is set it will be used to identify the host in Fleet Control instead of trying to fetch the identifier
158
-
from the
133
+
If the `host_id` is set it will be used to identify the host in Fleet Control instead of trying to fetch the identifier from the
159
134
host where Agent Control is running. Order of precedence:
160
135
161
136
1. Configured `host_id`.
@@ -170,8 +145,7 @@ host_id: "some-host-id" # Defaults to "" (no host set).
170
145
171
146
### k8s
172
147
173
-
The `k8s` configuration field applies for k8s environments only and are automatically set up through the corresponding
174
-
helm chart:
148
+
The `k8s` configuration field applies for k8s environments only and are automatically set up through the corresponding helm chart:
0 commit comments