Skip to content

Commit d7233aa

Browse files
jstirnamansanderson
jstirnaman
and
sanderson
authored
chore(v2): Port main telemetry page content to a v2-specific docs page (#6507)
* chore(v2): Port main telemetry page content to a v2-specific docs page * Update content/influxdb/v2/reference/telemetry.md Co-authored-by: Scott Anderson <[email protected]> --------- Co-authored-by: Scott Anderson <[email protected]>
1 parent e8a48e3 commit d7233aa

File tree

1 file changed

+73
-0
lines changed

1 file changed

+73
-0
lines changed

‎content/influxdb/v2/reference/telemetry.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
title: Usage telemetry
3+
description: >
4+
InfluxData collects information, or _telemetry data_, about the usage of {{% product-name %}} to help improve the product.
5+
Learn what data {{% product-name %}} collects and sends to InfluxData, how it's used, and
6+
how you can opt out.
7+
menu:
8+
influxdb_v2:
9+
name: Usage telemetry
10+
parent: Reference
11+
weight: 8
12+
related:
13+
- /influxdb/v2/reference/cli/influxd/
14+
- /influxdb/v2/reference/internals/metrics/
15+
---
16+
17+
InfluxData collects information, or *telemetry data*, about the usage of {{% product-name %}} to help improve the product.
18+
Learn what data {{% product-name %}} collects and sends to InfluxData, how it's used, and
19+
how you can opt out.
20+
21+
## Metrics Collection
22+
23+
For each InfluxDB 2.x installation, we collect the following at startup and then every 8 hours:
24+
25+
### Tags
26+
27+
| Tags | Description |
28+
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
29+
| arch | Microarchitecture InfluxDB was compiled for |
30+
| build date | Date associated with the InfluxDB build |
31+
| commit | SHA of commit associated with the InfluxDB build |
32+
| cpus | Number of CPUs running InfluxDB |
33+
| functions | Flux functions |
34+
| id | Snowflake identifier for the InfluxDB instance |
35+
| Index partition | Identifies the index partition used by the underlying InfluxDB storage engine |
36+
| ip | IP Address of the inbound connection which reports the statistics. This is **not** the specific IP Address of the machine running InfluxDB unless it is exposed directly on the public Internet. |
37+
| org | Identifier for an organization. Allows for grouping of statistics by organization within the InfluxDB instance |
38+
| os | Operating System InfluxDB is running on |
39+
| result | Text allowing grouping of Flux query invocations results |
40+
| series file partition | Identifies the series files in use for the underlying InfluxDB storage engine. This is not the metadata about series. |
41+
| status | Status of write ahead log (associated to number of successful /failed writes) |
42+
| user\_agent | Typically, this is set by the browser, InfluxDB client libraries (includes the language \[Go, JavaScript, Java, C#, Ruby, Python, etc.] and version), and other technologies \[such as third-party dashboarding applications, etc.]. |
43+
| version | InfluxDB version |
44+
45+
With those tag elements, we then leverage a combination of the unique combination of `id`, `ip`, and storage system specifics (where applicable) to capture usage counts of the various subsystems within InfluxDB.
46+
47+
### Fields
48+
49+
| Fields | Description |
50+
| --------------------------- | ----------------------------------------------------------------------------- |
51+
| buckets total counter | Total number of buckets present within the InfluxDB instance |
52+
| bytes written counter | Total number of bytes written |
53+
| bytes scanned counter | Total number of bytes scanned within the storage system via queries and tasks |
54+
| dashboards total counter | Total number of dashboards present within the InfluxDB instance |
55+
| flux function total counter | Total number of calls by function invoked within Flux |
56+
| http api requests counter | Total number of API invocations by each API path |
57+
| query duration histogram | Histogram counting duration of queries into bins |
58+
| organizations total counter | Total number of organizations present within the InfluxDB instance |
59+
| scrapers total counter | Total number of scrapers configured within the InfluxDB instance |
60+
| series total counter | Total number of series present within the InfluxDB instance |
61+
| storage total counter | Total number of bytes stored within the InfluxDB instance |
62+
| task scheduler gauge | Number of tasks running within the InfluxDB instance |
63+
| telegrafs total counter | Total number of Telegraf configurations within the InfluxDB instance |
64+
| tokens total counter | Total number of tokens present within the InfluxDB instance |
65+
| uptime gauge | Number of seconds InfluxDB has been continuously running |
66+
| users total counter | Total number of users present within the InfluxDB instance |
67+
| wal current segment gauge | Number of bytes in the current segments for the write ahead log |
68+
| wal writes total counter | Total number of writes to the write ahead log by status (ok, fail, etc.) |
69+
70+
## Disable telemetry
71+
72+
To "opt-out" of collecting and sending {{% product-name %}} telemetry data,
73+
include the `--reporting-disabled` flag with the `influxd` command when starting {{% product-name %}}.

0 commit comments

Comments
 (0)