FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
telemetryflow-agent/.env.example at main · telemetryflow/telemetryflow-agent · GitHub
telemetryflow
telemetryflow-agent
Repository navigation
Code
Issues
Pull requests
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
telemetryflow-agent
/
.env.example
Copy path
More file actions
More file actions
Latest commit
History
History
History
442 lines (390 loc) · 15.7 KB
Breadcrumbs
telemetryflow-agent
/
.env.example
Copy path
File metadata and controls
442 lines (390 loc) · 15.7 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
#
=============================================================================
#
TelemetryFlow Agent - Environment Variables
#
=============================================================================
#
Copy this file to .env and update the values as needed
#
=============================================================================
#
-----------------------------------------------------------------------------
#
Build Configuration
#
-----------------------------------------------------------------------------
VERSION
=
1.2.2
OTEL_SDK_VERSION
=
1.40.0
GIT_COMMIT
=
unknown
GIT_BRANCH
=
main
BUILD_TIME
=
unknown
#
-----------------------------------------------------------------------------
#
Container Configuration
#
-----------------------------------------------------------------------------
CONTAINER_NAME
=
tfo-agent
IMAGE_NAME
=
telemetryflow/telemetryflow-agent
IMAGE_TAG
=
1.2.2
#
-----------------------------------------------------------------------------
#
Network Configuration
#
-----------------------------------------------------------------------------
#
OTLP gRPC receiver port
OTLP_GRPC_PORT
=
4317
#
OTLP HTTP receiver port
OTLP_HTTP_PORT
=
4318
#
Prometheus metrics port (self-observability)
METRICS_PORT
=
8888
#
Health check port
HEALTH_PORT
=
13133
#
Prometheus Remote Write receiver port (disabled by default)
REMOTE_WRITE_RECEIVER_PORT
=
9091
#
-----------------------------------------------------------------------------
#
TelemetryFlow API Configuration
#
-----------------------------------------------------------------------------
TELEMETRYFLOW_API_ENDPOINT
=
http://localhost:3100
TELEMETRYFLOW_API_KEY_ID
=
your-api-key-id
TELEMETRYFLOW_API_KEY_SECRET
=
your-api-key-secret
#
Kubernetes Cluster ID — registered in TFO Platform
#
Step 1: POST /api/v2/monitoring/kubernetes/clusters (JWT auth) → get {id}
#
Step 2: Paste UUID here AND in tfo-agent.yaml: collectors.kubernetes.cluster_id
TELEMETRYFLOW_K8S_CLUSTER_ID
=
#
-----------------------------------------------------------------------------
#
Collector Endpoint (where agent sends telemetry)
#
-----------------------------------------------------------------------------
COLLECTOR_ENDPOINT
=
http://tfo-collector:4317
COLLECTOR_INSECURE
=
true
#
-----------------------------------------------------------------------------
#
Agent Configuration
#
-----------------------------------------------------------------------------
AGENT_HOSTNAME
=
AGENT_DESCRIPTION
=
TelemetryFlow Agent
#
Heartbeat interval
HEARTBEAT_INTERVAL
=
30s
HEARTBEAT_TIMEOUT
=
10s
#
-----------------------------------------------------------------------------
#
Kubernetes Collector - KSM Gap Fields
#
Extra kube-state-metrics equivalent fields (disabled by default to reduce cardinality)
#
TFOAGENT_ prefix maps to collectors.kubernetes.<field>
#
-----------------------------------------------------------------------------
TFOAGENT_COLLECTORS_KUBERNETES_RESOURCE_QUOTAS
=
false
TFOAGENT_COLLECTORS_KUBERNETES_LIMIT_RANGES
=
false
TFOAGENT_COLLECTORS_KUBERNETES_POD_CONDITIONS
=
false
TFOAGENT_COLLECTORS_KUBERNETES_NODE_TAINTS
=
false
TFOAGENT_COLLECTORS_KUBERNETES_WORKLOAD_GENERATIONS
=
false
#
-----------------------------------------------------------------------------
#
Logging Configuration
#
-----------------------------------------------------------------------------
LOG_LEVEL
=
info
LOG_FORMAT
=
json
#
-----------------------------------------------------------------------------
#
Buffer Configuration
#
-----------------------------------------------------------------------------
BUFFER_ENABLED
=
true
BUFFER_PATH
=
/var/lib/tfo-agent/buffer
BUFFER_MAX_SIZE_MB
=
100
#
-----------------------------------------------------------------------------
#
Resource Limits
#
-----------------------------------------------------------------------------
MEMORY_LIMIT
=
512M
CPU_LIMIT
=
0.5
#
=============================================================================
#
Integration Configurations (Alphabetically Sorted)
#
=============================================================================
#
Total: 35+ integrations across cloud, observability, and infrastructure
#
All integrations are disabled by default - enable as needed
#
-----------------------------------------------------------------------------
#
Alibaba Cloud Integration
#
-----------------------------------------------------------------------------
ALIBABA_ENABLED
=
false
ALIBABA_REGION_ID
=
cn-hangzhou
ALIBABA_ACCESS_KEY_ID
=
ALIBABA_ACCESS_KEY_SECRET
=
ALIBABA_NAMESPACE
=
acs_custom
ALIBABA_PROJECT
=
ALIBABA_LOGSTORE
=
#
-----------------------------------------------------------------------------
#
Alloy (Grafana Agent) Integration
#
-----------------------------------------------------------------------------
ALLOY_ENABLED
=
false
ALLOY_ENDPOINT
=
http://localhost:4318
ALLOY_TENANT_ID
=
#
-----------------------------------------------------------------------------
#
Azure Integration
#
-----------------------------------------------------------------------------
AZURE_ENABLED
=
false
AZURE_SUBSCRIPTION_ID
=
AZURE_RESOURCE_GROUP
=
AZURE_TENANT_ID
=
AZURE_CLIENT_ID
=
AZURE_CLIENT_SECRET
=
AZURE_REGION
=
eastus
AZURE_WORKSPACE_ID
=
AZURE_WORKSPACE_KEY
=
AZURE_INSTRUMENTATION_KEY
=
#
-----------------------------------------------------------------------------
#
Azure Arc Integration
#
-----------------------------------------------------------------------------
AZUREARC_ENABLED
=
false
AZUREARC_SUBSCRIPTION_ID
=
AZUREARC_RESOURCE_GROUP
=
AZUREARC_TENANT_ID
=
AZUREARC_CLIENT_ID
=
AZUREARC_CLIENT_SECRET
=
AZUREARC_USE_MANAGED_IDENTITY
=
false
#
-----------------------------------------------------------------------------
#
Blackbox Exporter Integration
#
-----------------------------------------------------------------------------
BLACKBOX_ENABLED
=
false
BLACKBOX_ENDPOINT
=
http://localhost:9115
BLACKBOX_TARGETS
=
#
-----------------------------------------------------------------------------
#
Cisco DNA Center / Meraki Integration
#
-----------------------------------------------------------------------------
CISCO_ENABLED
=
false
CISCO_API_TYPE
=
dnac
CISCO_DNAC_URL
=
CISCO_USERNAME
=
CISCO_PASSWORD
=
#
-----------------------------------------------------------------------------
#
AWS CloudWatch Integration
#
-----------------------------------------------------------------------------
CLOUDWATCH_ENABLED
=
false
CLOUDWATCH_REGION
=
us-east-1
CLOUDWATCH_ACCESS_KEY_ID
=
CLOUDWATCH_SECRET_ACCESS_KEY
=
CLOUDWATCH_NAMESPACE
=
TelemetryFlow
CLOUDWATCH_LOG_GROUP
=
/telemetryflow/agent
CLOUDWATCH_LOG_STREAM
=
#
-----------------------------------------------------------------------------
#
Coroot Integration
#
-----------------------------------------------------------------------------
COROOT_ENABLED
=
false
COROOT_ENDPOINT
=
http://localhost:8080
COROOT_API_KEY
=
COROOT_SERVICE_NAME
=
tfo-agent
#
-----------------------------------------------------------------------------
#
Datadog Integration
#
-----------------------------------------------------------------------------
DATADOG_ENABLED
=
false
DATADOG_API_KEY
=
DATADOG_SITE
=
datadoghq.com
DATADOG_SERVICE
=
telemetryflow
DATADOG_ENV
=
production
#
-----------------------------------------------------------------------------
#
Dynatrace Integration
#
-----------------------------------------------------------------------------
DYNATRACE_ENABLED
=
false
DYNATRACE_ENVIRONMENT_ID
=
DYNATRACE_API_TOKEN
=
DYNATRACE_ENVIRONMENT_URL
=
DYNATRACE_METRIC_PREFIX
=
telemetryflow
DYNATRACE_API_VERSION
=
v2
#
-----------------------------------------------------------------------------
#
Elasticsearch Integration
#
-----------------------------------------------------------------------------
ELASTICSEARCH_ENABLED
=
false
ELASTICSEARCH_ADDRESSES
=
http://localhost:9200
ELASTICSEARCH_USERNAME
=
ELASTICSEARCH_PASSWORD
=
ELASTICSEARCH_INDEX_PREFIX
=
telemetryflow
#
-----------------------------------------------------------------------------
#
GCP (Google Cloud Platform) Integration
#
-----------------------------------------------------------------------------
GCP_ENABLED
=
false
GCP_PROJECT_ID
=
GCP_CREDENTIALS_FILE
=
GCP_REGION
=
us-central1
GCP_METRIC_PREFIX
=
custom.googleapis.com/telemetryflow
GCP_LOG_NAME
=
telemetryflow
GCP_MONITORING_ENDPOINT
=
https://monitoring.googleapis.com/v3
GCP_LOGGING_ENDPOINT
=
https://logging.googleapis.com/v2
GCP_TRACE_ENDPOINT
=
https://cloudtrace.googleapis.com/v2
#
-----------------------------------------------------------------------------
#
HyperDX Integration
#
-----------------------------------------------------------------------------
HYPERDX_ENABLED
=
false
HYPERDX_ENDPOINT
=
https://in-otel.hyperdx.io
HYPERDX_API_KEY
=
HYPERDX_SERVICE_NAME
=
tfo-agent
#
-----------------------------------------------------------------------------
#
InfluxDB Integration
#
-----------------------------------------------------------------------------
INFLUXDB_ENABLED
=
false
INFLUXDB_URL
=
http://localhost:8086
INFLUXDB_TOKEN
=
INFLUXDB_ORG
=
INFLUXDB_BUCKET
=
telemetryflow
#
-----------------------------------------------------------------------------
#
IBM Instana Integration
#
-----------------------------------------------------------------------------
INSTANA_ENABLED
=
false
INSTANA_ENDPOINT
=
INSTANA_AGENT_KEY
=
INSTANA_ZONE
=
default
INSTANA_CLUSTER_NAME
=
INSTANA_HOST_AGENT
=
#
-----------------------------------------------------------------------------
#
Jaeger Integration
#
-----------------------------------------------------------------------------
JAEGER_ENABLED
=
false
JAEGER_COLLECTOR_ENDPOINT
=
http://localhost:14268/api/traces
JAEGER_AGENT_HOST
=
localhost
JAEGER_AGENT_PORT
=
6831
#
-----------------------------------------------------------------------------
#
Kafka Integration
#
-----------------------------------------------------------------------------
KAFKA_ENABLED
=
false
KAFKA_BROKERS
=
localhost:9092
KAFKA_METRICS_TOPIC
=
telemetryflow-metrics
KAFKA_LOGS_TOPIC
=
telemetryflow-logs
KAFKA_TRACES_TOPIC
=
telemetryflow-traces
KAFKA_SASL_MECHANISM
=
KAFKA_SASL_USERNAME
=
KAFKA_SASL_PASSWORD
=
#
-----------------------------------------------------------------------------
#
Loki (Grafana) Integration
#
-----------------------------------------------------------------------------
LOKI_ENABLED
=
false
LOKI_ENDPOINT
=
http://localhost:3100
LOKI_TENANT_ID
=
LOKI_BATCH_SIZE
=
100
#
-----------------------------------------------------------------------------
#
ManageEngine Integration
#
-----------------------------------------------------------------------------
MANAGEENGINE_ENABLED
=
false
MANAGEENGINE_PRODUCT
=
opmanager
MANAGEENGINE_OPMANAGER_ENDPOINT
=
MANAGEENGINE_OPMANAGER_API_KEY
=
MANAGEENGINE_APPMANAGER_ENDPOINT
=
MANAGEENGINE_APPMANAGER_API_KEY
=
MANAGEENGINE_USERNAME
=
MANAGEENGINE_PASSWORD
=
#
-----------------------------------------------------------------------------
#
MQTT Integration
#
-----------------------------------------------------------------------------
MQTT_ENABLED
=
false
MQTT_BROKER
=
tcp://localhost:1883
MQTT_CLIENT_ID
=
tfo-agent
MQTT_USERNAME
=
MQTT_PASSWORD
=
MQTT_METRICS_TOPIC
=
telemetryflow/metrics
MQTT_LOGS_TOPIC
=
telemetryflow/logs
MQTT_TRACES_TOPIC
=
telemetryflow/traces
#
-----------------------------------------------------------------------------
#
Netdata Cloud Integration
#
-----------------------------------------------------------------------------
NETDATA_ENABLED
=
false
NETDATA_ENDPOINT
=
https://api.netdata.cloud
NETDATA_API_TOKEN
=
NETDATA_SPACE_ID
=
NETDATA_ROOM_ID
=
NETDATA_CLAIM_TOKEN
=
NETDATA_HOSTNAME_OVERRIDE
=
#
-----------------------------------------------------------------------------
#
New Relic Integration
#
-----------------------------------------------------------------------------
NEWRELIC_ENABLED
=
false
NEWRELIC_LICENSE_KEY
=
NEWRELIC_REGION
=
US
NEWRELIC_SERVICE_NAME
=
telemetryflow
NEWRELIC_ENVIRONMENT
=
production
#
-----------------------------------------------------------------------------
#
Nutanix Integration
#
-----------------------------------------------------------------------------
NUTANIX_ENABLED
=
false
NUTANIX_PRISM_URL
=
NUTANIX_USERNAME
=
NUTANIX_PASSWORD
=
NUTANIX_CLUSTER_UUID
=
#
-----------------------------------------------------------------------------
#
OpenObserve Integration
#
-----------------------------------------------------------------------------
OPENOBSERVE_ENABLED
=
false
OPENOBSERVE_ENDPOINT
=
http://localhost:5080
OPENOBSERVE_USERNAME
=
OPENOBSERVE_PASSWORD
=
OPENOBSERVE_ORG
=
default
OPENOBSERVE_STREAM
=
default
#
-----------------------------------------------------------------------------
#
Percona PMM Integration
#
-----------------------------------------------------------------------------
PERCONA_ENABLED
=
false
PERCONA_SERVER_URL
=
PERCONA_API_KEY
=
PERCONA_USERNAME
=
PERCONA_PASSWORD
=
#
-----------------------------------------------------------------------------
#
Prometheus Remote Write Receiver
#
Enables push-based metric ingestion from Prometheus / compatible agents
#
-----------------------------------------------------------------------------
#
Enable the receiver (TFOAGENT_ prefix maps to collectors.remote_write_receiver)
TFOAGENT_COLLECTORS_REMOTE_WRITE_RECEIVER_ENABLED
=
false
TFOAGENT_COLLECTORS_REMOTE_WRITE_RECEIVER_PORT
=
9091
TFOAGENT_COLLECTORS_REMOTE_WRITE_RECEIVER_BUFFER_SIZE
=
10000
#
Optional basic auth (leave blank to disable)
TFOAGENT_COLLECTORS_REMOTE_WRITE_RECEIVER_BASIC_AUTH_USERNAME
=
TFOAGENT_COLLECTORS_REMOTE_WRITE_RECEIVER_BASIC_AUTH_PASSWORD
=
#
-----------------------------------------------------------------------------
#
Prometheus Integration
#
-----------------------------------------------------------------------------
PROMETHEUS_ENABLED
=
false
PROMETHEUS_ENDPOINT
=
http://localhost:9090/api/v1/write
PROMETHEUS_JOB_NAME
=
telemetryflow-agent
PROMETHEUS_TIMEOUT
=
30s
#
-----------------------------------------------------------------------------
#
Proxmox Integration
#
-----------------------------------------------------------------------------
PROXMOX_ENABLED
=
false
PROXMOX_API_URL
=
PROXMOX_USERNAME
=
root@pam
PROXMOX_PASSWORD
=
PROXMOX_TOKEN_ID
=
PROXMOX_TOKEN_SECRET
=
PROXMOX_TLS_SKIP_VERIFY
=
false
#
-----------------------------------------------------------------------------
#
SigNoz Integration
#
-----------------------------------------------------------------------------
SIGNOZ_ENABLED
=
false
SIGNOZ_ENDPOINT
=
http://localhost:4318
SIGNOZ_ACCESS_TOKEN
=
SIGNOZ_SERVICE_NAME
=
tfo-agent
#
-----------------------------------------------------------------------------
#
SNMP Integration
#
-----------------------------------------------------------------------------
SNMP_ENABLED
=
false
SNMP_TARGETS
=
SNMP_COMMUNITY
=
public
SNMP_VERSION
=
2c
SNMP_TIMEOUT
=
10s
#
-----------------------------------------------------------------------------
#
Splunk Integration
#
-----------------------------------------------------------------------------
SPLUNK_ENABLED
=
false
SPLUNK_HEC_ENDPOINT
=
SPLUNK_HEC_TOKEN
=
SPLUNK_INDEX
=
main
SPLUNK_SOURCE
=
telemetryflow
SPLUNK_SOURCETYPE
=
_json
#
-----------------------------------------------------------------------------
#
Telegraf Integration
#
-----------------------------------------------------------------------------
TELEGRAF_ENABLED
=
false
TELEGRAF_ADDRESS
=
http://localhost:8186
TELEGRAF_PROTOCOL
=
http
TELEGRAF_DATABASE
=
telegraf
TELEGRAF_PRECISION
=
ns
#
-----------------------------------------------------------------------------
#
VMware vCenter Integration
#
-----------------------------------------------------------------------------
VMWARE_ENABLED
=
false
VMWARE_VCENTER_URL
=
VMWARE_USERNAME
=
VMWARE_PASSWORD
=
VMWARE_DATACENTER
=
VMWARE_TLS_SKIP_VERIFY
=
false
#
-----------------------------------------------------------------------------
#
Webhook Integration
#
-----------------------------------------------------------------------------
WEBHOOK_ENABLED
=
false
WEBHOOK_URL
=
WEBHOOK_METHOD
=
POST
WEBHOOK_SECRET
=
WEBHOOK_TIMEOUT
=
30s
WEBHOOK_RETRY_COUNT
=
3
#
-----------------------------------------------------------------------------
#
Zipkin Integration
#
-----------------------------------------------------------------------------
ZIPKIN_ENABLED
=
false
ZIPKIN_ENDPOINT
=
http://localhost:9411/api/v2/spans
Back
|
FazBrowse Home
|
New Git URL