Regenerate integrations.js (#17944)
Co-authored-by: ilyam8 <22274335+ilyam8@users.noreply.github.com>
Netdata bot committed
Jun 18, 2024 at 02:50 UTC
58d9951997836b2935d60758aaa3168efa94ee97
3 files changed
+214
integrations/integrations.js
+28
@@ -21240,6 +21240,34 @@ export const integrations = [
21240
"edit_link": "https://github.com/netdata/netdata/blob/master/src/exporting/prometheus/metadata.yaml",
21241
"troubleshooting": ""
21242
},
21243
+ {
21244
+ "id": "export-opensearch",
21245
+ "meta": {
21246
+ "name": "OpeanSearch",
21247
+ "link": "https://opensearch.org/",
21248
+ "categories": [
21249
+ "export"
21250
+ ],
21251
+ "icon_filename": "opensearch.svg",
21252
+ "keywords": [
21253
+ "export",
21254
+ "OpenSearch",
21255
+ "prometheus",
21256
+ "remote write"
21257
+ ]
21258
+ },
21259
+ "keywords": [
21260
+ "exporter",
21261
+ "Prometheus",
21262
+ "remote write",
21263
+ "time series"
21264
+ ],
21265
+ "overview": "# OpeanSearch\n\nUse the Prometheus remote write exporting connector to archive your Netdata metrics to the external storage provider of your choice for long-term storage and further analysis.\n\n\n## Limitations\n\nThe remote write exporting connector does not support buffer on failures.\n",
21266
+ "setup": "## Setup\n\n### Prerequisites\n\n#### \n\n- Netdata and the external storage provider of your choice, installed, configured and operational.\n- `protobuf` and `snappy` libraries installed.\n- Netdata reinstalled after the libraries.\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `exporting.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config exporting.conf\n```\n#### Options\n\nThe following options can be defined for this exporter.\n\n{% details open=true summary=\"Config options\" %}\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| enabled | Enables or disables an exporting connector instance (yes/no). | no | yes |\n| destination | Accepts a space separated list of hostnames, IPs (IPv4 and IPv6) and ports to connect to. Netdata will use the first available to send the metrics. | no | yes |\n| username | Username for HTTP authentication | my_username | no |\n| password | Password for HTTP authentication | my_password | no |\n| data source | Selects the kind of data that will be sent to the external database. (as collected/average/sum) | | no |\n| hostname | The hostname to be used for sending data to the external database server. | [global].hostname | no |\n| prefix | The prefix to add to all metrics. | netdata | no |\n| update every | Frequency of sending sending data to the external database, in seconds. | 10 | no |\n| buffer on failures | The number of iterations (`update every` seconds) to buffer data, when the external database server is not available. | 10 | no |\n| timeout ms | The timeout in milliseconds to wait for the external database server to process the data. | 20000 | no |\n| send hosts matching | Hosts filter. Determines which hosts will be sent to the external database. The syntax is [simple patterns](https://github.com/netdata/netdata/tree/master/src/libnetdata/simple_pattern#simple-patterns). | localhost * | no |\n| send charts matching | One or more space separated patterns (use * as wildcard) checked against both chart id and chart name. | * | no |\n| send names instead of ids | Controls the metric names Netdata should send to the external database (yes/no). | | no |\n| send configured labels | Controls if host labels defined in the `[host labels]` section in `netdata.conf` should be sent to the external database (yes/no). | | no |\n| send automatic labels | Controls if automatically created labels, like `_os_name` or `_architecture` should be sent to the external database (yes/no). | | no |\n\n##### destination\n\nThe format of each item in this list, is: [PROTOCOL:]IP[:PORT].\n- PROTOCOL can be udp or tcp. tcp is the default and only supported by the current exporting engine.\n- IP can be XX.XX.XX.XX (IPv4), or [XX:XX...XX:XX] (IPv6). For IPv6 you can to enclose the IP in [] to separate it from the port.\n- PORT can be a number of a service name. If omitted, the default port for the exporting connector will be used.\n\nExample IPv4:\n ```yaml\n destination = 10.11.14.2:2003 10.11.14.3:4242 10.11.14.4:2003\n ```\nExample IPv6 and IPv4 together:\n```yaml\ndestination = [ffff:...:0001]:2003 10.11.12.1:2003\n```\nWhen multiple servers are defined, Netdata will try the next one when the previous one fails.\n\n\n##### update every\n\nNetdata will add some randomness to this number, to prevent stressing the external server when many Netdata servers\nsend data to the same database. This randomness does not affect the quality of the data, only the time they are sent.\n\n\n##### buffer on failures\n\nIf the server fails to receive the data after that many failures, data loss on the connector instance is expected (Netdata will also log it).\n\n\n##### send hosts matching\n\nIncludes one or more space separated patterns, using * as wildcard (any number of times within each pattern).\nThe patterns are checked against the hostname (the localhost is always checked as localhost), allowing us to\nfilter which hosts will be sent to the external database when this Netdata is a central Netdata aggregating multiple hosts.\n\nA pattern starting with `!` gives a negative match. So to match all hosts named `*db*` except hosts containing `*child*`,\nuse `!*child* *db*` (so, the order is important: the first pattern matching the hostname will be used - positive or negative).\n\n\n##### send charts matching\n\nA pattern starting with ! gives a negative match. So to match all charts named apps.* except charts ending in *reads,\nuse !*reads apps.* (so, the order is important: the first pattern matching the chart id or the chart name will be used,\npositive or negative). There is also a URL parameter filter that can be used while querying allmetrics. The URL parameter\nhas a higher priority than the configuration option.\n\n\n##### send names instead of ids\n\nNetdata supports names and IDs for charts and dimensions. Usually IDs are unique identifiers as read by the system and names\nare human friendly labels (also unique). Most charts and metrics have the same ID and name, but in several cases they are\ndifferent : disks with device-mapper, interrupts, QoS classes, statsd synthetic charts, etc.\n\n\n{% /details %}\n#### Examples\n\n##### Example configuration\n\nBasic example configuration for Prometheus remote write.\n\n```yaml\n[prometheus_remote_write:my_instance]\n enabled = yes\n destination = 10.11.14.2:2003\n remote write URL path = /receive\n\n```\n##### Example configuration with HTTPS and HTTP authentication\n\nAdd `:https` modifier to the connector type if you need to use the TLS/SSL protocol. For example: `remote_write:https:my_instance`.\n\n```yaml\n[prometheus_remote_write:https:my_instance]\n enabled = yes\n destination = 10.11.14.2:2003\n remote write URL path = /receive\n username = my_username\n password = my_password\n\n```\n",
21267
+ "integration_type": "exporter",
21268
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/exporting/prometheus/metadata.yaml",
21269
+ "troubleshooting": ""
21270
+ },
21271
{
21272
"id": "export-opentsdb",
21273
"meta": {
integrations/integrations.json
+28
@@ -21238,6 +21238,34 @@
21238
"edit_link": "https://github.com/netdata/netdata/blob/master/src/exporting/prometheus/metadata.yaml",
21239
"troubleshooting": ""
21240
},
21241
+ {
21242
+ "id": "export-opensearch",
21243
+ "meta": {
21244
+ "name": "OpeanSearch",
21245
+ "link": "https://opensearch.org/",
21246
+ "categories": [
21247
+ "export"
21248
+ ],
21249
+ "icon_filename": "opensearch.svg",
21250
+ "keywords": [
21251
+ "export",
21252
+ "OpenSearch",
21253
+ "prometheus",
21254
+ "remote write"
21255
+ ]
21256
+ },
21257
+ "keywords": [
21258
+ "exporter",
21259
+ "Prometheus",
21260
+ "remote write",
21261
+ "time series"
21262
+ ],
21263
+ "overview": "# OpeanSearch\n\nUse the Prometheus remote write exporting connector to archive your Netdata metrics to the external storage provider of your choice for long-term storage and further analysis.\n\n\n## Limitations\n\nThe remote write exporting connector does not support buffer on failures.\n",
21264
+ "setup": "## Setup\n\n### Prerequisites\n\n#### \n\n- Netdata and the external storage provider of your choice, installed, configured and operational.\n- `protobuf` and `snappy` libraries installed.\n- Netdata reinstalled after the libraries.\n\n\n\n### Configuration\n\n#### File\n\nThe configuration file name for this integration is `exporting.conf`.\n\n\nYou can edit the configuration file using the `edit-config` script from the\nNetdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).\n\n```bash\ncd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata\nsudo ./edit-config exporting.conf\n```\n#### Options\n\nThe following options can be defined for this exporter.\n\n| Name | Description | Default | Required |\n|:----|:-----------|:-------|:--------:|\n| enabled | Enables or disables an exporting connector instance (yes/no). | no | yes |\n| destination | Accepts a space separated list of hostnames, IPs (IPv4 and IPv6) and ports to connect to. Netdata will use the first available to send the metrics. | no | yes |\n| username | Username for HTTP authentication | my_username | no |\n| password | Password for HTTP authentication | my_password | no |\n| data source | Selects the kind of data that will be sent to the external database. (as collected/average/sum) | | no |\n| hostname | The hostname to be used for sending data to the external database server. | [global].hostname | no |\n| prefix | The prefix to add to all metrics. | netdata | no |\n| update every | Frequency of sending sending data to the external database, in seconds. | 10 | no |\n| buffer on failures | The number of iterations (`update every` seconds) to buffer data, when the external database server is not available. | 10 | no |\n| timeout ms | The timeout in milliseconds to wait for the external database server to process the data. | 20000 | no |\n| send hosts matching | Hosts filter. Determines which hosts will be sent to the external database. The syntax is [simple patterns](https://github.com/netdata/netdata/tree/master/src/libnetdata/simple_pattern#simple-patterns). | localhost * | no |\n| send charts matching | One or more space separated patterns (use * as wildcard) checked against both chart id and chart name. | * | no |\n| send names instead of ids | Controls the metric names Netdata should send to the external database (yes/no). | | no |\n| send configured labels | Controls if host labels defined in the `[host labels]` section in `netdata.conf` should be sent to the external database (yes/no). | | no |\n| send automatic labels | Controls if automatically created labels, like `_os_name` or `_architecture` should be sent to the external database (yes/no). | | no |\n\n##### destination\n\nThe format of each item in this list, is: [PROTOCOL:]IP[:PORT].\n- PROTOCOL can be udp or tcp. tcp is the default and only supported by the current exporting engine.\n- IP can be XX.XX.XX.XX (IPv4), or [XX:XX...XX:XX] (IPv6). For IPv6 you can to enclose the IP in [] to separate it from the port.\n- PORT can be a number of a service name. If omitted, the default port for the exporting connector will be used.\n\nExample IPv4:\n ```yaml\n destination = 10.11.14.2:2003 10.11.14.3:4242 10.11.14.4:2003\n ```\nExample IPv6 and IPv4 together:\n```yaml\ndestination = [ffff:...:0001]:2003 10.11.12.1:2003\n```\nWhen multiple servers are defined, Netdata will try the next one when the previous one fails.\n\n\n##### update every\n\nNetdata will add some randomness to this number, to prevent stressing the external server when many Netdata servers\nsend data to the same database. This randomness does not affect the quality of the data, only the time they are sent.\n\n\n##### buffer on failures\n\nIf the server fails to receive the data after that many failures, data loss on the connector instance is expected (Netdata will also log it).\n\n\n##### send hosts matching\n\nIncludes one or more space separated patterns, using * as wildcard (any number of times within each pattern).\nThe patterns are checked against the hostname (the localhost is always checked as localhost), allowing us to\nfilter which hosts will be sent to the external database when this Netdata is a central Netdata aggregating multiple hosts.\n\nA pattern starting with `!` gives a negative match. So to match all hosts named `*db*` except hosts containing `*child*`,\nuse `!*child* *db*` (so, the order is important: the first pattern matching the hostname will be used - positive or negative).\n\n\n##### send charts matching\n\nA pattern starting with ! gives a negative match. So to match all charts named apps.* except charts ending in *reads,\nuse !*reads apps.* (so, the order is important: the first pattern matching the chart id or the chart name will be used,\npositive or negative). There is also a URL parameter filter that can be used while querying allmetrics. The URL parameter\nhas a higher priority than the configuration option.\n\n\n##### send names instead of ids\n\nNetdata supports names and IDs for charts and dimensions. Usually IDs are unique identifiers as read by the system and names\nare human friendly labels (also unique). Most charts and metrics have the same ID and name, but in several cases they are\ndifferent : disks with device-mapper, interrupts, QoS classes, statsd synthetic charts, etc.\n\n\n#### Examples\n\n##### Example configuration\n\nBasic example configuration for Prometheus remote write.\n\n```yaml\n[prometheus_remote_write:my_instance]\n enabled = yes\n destination = 10.11.14.2:2003\n remote write URL path = /receive\n\n```\n##### Example configuration with HTTPS and HTTP authentication\n\nAdd `:https` modifier to the connector type if you need to use the TLS/SSL protocol. For example: `remote_write:https:my_instance`.\n\n```yaml\n[prometheus_remote_write:https:my_instance]\n enabled = yes\n destination = 10.11.14.2:2003\n remote write URL path = /receive\n username = my_username\n password = my_password\n\n```\n",
21265
+ "integration_type": "exporter",
21266
+ "edit_link": "https://github.com/netdata/netdata/blob/master/src/exporting/prometheus/metadata.yaml",
21267
+ "troubleshooting": ""
21268
+ },
21269
{
21270
"id": "export-opentsdb",
21271
"meta": {
src/exporting/prometheus/integrations/opeansearch.md
new
+158
@@ -0,0 +1,158 @@
1
+<!--startmeta
2
+custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/exporting/prometheus/integrations/opeansearch.md"
3
+meta_yaml: "https://github.com/netdata/netdata/edit/master/src/exporting/prometheus/metadata.yaml"
4
+sidebar_label: "OpeanSearch"
5
+learn_status: "Published"
6
+learn_rel_path: "Exporting Metrics"
7
+message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE EXPORTER'S metadata.yaml FILE"
8
+endmeta-->
9
+
10
+# OpeanSearch
11
+
12
+
13
+<img src="https://netdata.cloud/img/opensearch.svg" width="150"/>
14
+
15
+
16
+Use the Prometheus remote write exporting connector to archive your Netdata metrics to the external storage provider of your choice for long-term storage and further analysis.
17
+
18
+
19
+<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />
20
+
21
+## Limitations
22
+
23
+The remote write exporting connector does not support buffer on failures.
24
+
25
+
26
+## Setup
27
+
28
+### Prerequisites
29
+
30
+####
31
+
32
+- Netdata and the external storage provider of your choice, installed, configured and operational.
33
+- `protobuf` and `snappy` libraries installed.
34
+- Netdata reinstalled after the libraries.
35
+
36
+
37
+
38
+### Configuration
39
+
40
+#### File
41
+
42
+The configuration file name for this integration is `exporting.conf`.
43
+
44
+
45
+You can edit the configuration file using the `edit-config` script from the
46
+Netdata [config directory](/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).
47
+
48
+```bash
49
+cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
50
+sudo ./edit-config exporting.conf
51
+```
52
+#### Options
53
+
54
+The following options can be defined for this exporter.
55
+
56
+<details open><summary>Config options</summary>
57
+
58
+| Name | Description | Default | Required |
59
+|:----|:-----------|:-------|:--------:|
60
+| enabled | Enables or disables an exporting connector instance (yes/no). | no | yes |
61
+| destination | Accepts a space separated list of hostnames, IPs (IPv4 and IPv6) and ports to connect to. Netdata will use the first available to send the metrics. | no | yes |
62
+| username | Username for HTTP authentication | my_username | no |
63
+| password | Password for HTTP authentication | my_password | no |
64
+| data source | Selects the kind of data that will be sent to the external database. (as collected/average/sum) | | no |
65
+| hostname | The hostname to be used for sending data to the external database server. | [global].hostname | no |
66
+| prefix | The prefix to add to all metrics. | netdata | no |
67
+| update every | Frequency of sending sending data to the external database, in seconds. | 10 | no |
68
+| buffer on failures | The number of iterations (`update every` seconds) to buffer data, when the external database server is not available. | 10 | no |
69
+| timeout ms | The timeout in milliseconds to wait for the external database server to process the data. | 20000 | no |
70
+| send hosts matching | Hosts filter. Determines which hosts will be sent to the external database. The syntax is [simple patterns](https://github.com/netdata/netdata/tree/master/src/libnetdata/simple_pattern#simple-patterns). | localhost * | no |
71
+| send charts matching | One or more space separated patterns (use * as wildcard) checked against both chart id and chart name. | * | no |
72
+| send names instead of ids | Controls the metric names Netdata should send to the external database (yes/no). | | no |
73
+| send configured labels | Controls if host labels defined in the `[host labels]` section in `netdata.conf` should be sent to the external database (yes/no). | | no |
74
+| send automatic labels | Controls if automatically created labels, like `_os_name` or `_architecture` should be sent to the external database (yes/no). | | no |
75
+
76
+##### destination
77
+
78
+The format of each item in this list, is: [PROTOCOL:]IP[:PORT].
79
+- PROTOCOL can be udp or tcp. tcp is the default and only supported by the current exporting engine.
80
+- IP can be XX.XX.XX.XX (IPv4), or [XX:XX...XX:XX] (IPv6). For IPv6 you can to enclose the IP in [] to separate it from the port.
81
+- PORT can be a number of a service name. If omitted, the default port for the exporting connector will be used.
82
+
83
+Example IPv4:
84
+ ```yaml
85
+ destination = 10.11.14.2:2003 10.11.14.3:4242 10.11.14.4:2003
86
+ ```
87
+Example IPv6 and IPv4 together:
88
+```yaml
89
+destination = [ffff:...:0001]:2003 10.11.12.1:2003
90
+```
91
+When multiple servers are defined, Netdata will try the next one when the previous one fails.
92
+
93
+
94
+##### update every
95
+
96
+Netdata will add some randomness to this number, to prevent stressing the external server when many Netdata servers
97
+send data to the same database. This randomness does not affect the quality of the data, only the time they are sent.
98
+
99
+
100
+##### buffer on failures
101
+
102
+If the server fails to receive the data after that many failures, data loss on the connector instance is expected (Netdata will also log it).
103
+
104
+
105
+##### send hosts matching
106
+
107
+Includes one or more space separated patterns, using * as wildcard (any number of times within each pattern).
108
+The patterns are checked against the hostname (the localhost is always checked as localhost), allowing us to
109
+filter which hosts will be sent to the external database when this Netdata is a central Netdata aggregating multiple hosts.
110
+
111
+A pattern starting with `!` gives a negative match. So to match all hosts named `*db*` except hosts containing `*child*`,
112
+use `!*child* *db*` (so, the order is important: the first pattern matching the hostname will be used - positive or negative).
113
+
114
+
115
+##### send charts matching
116
+
117
+A pattern starting with ! gives a negative match. So to match all charts named apps.* except charts ending in *reads,
118
+use !*reads apps.* (so, the order is important: the first pattern matching the chart id or the chart name will be used,
119
+positive or negative). There is also a URL parameter filter that can be used while querying allmetrics. The URL parameter
120
+has a higher priority than the configuration option.
121
+
122
+
123
+##### send names instead of ids
124
+
125
+Netdata supports names and IDs for charts and dimensions. Usually IDs are unique identifiers as read by the system and names
126
+are human friendly labels (also unique). Most charts and metrics have the same ID and name, but in several cases they are
127
+different : disks with device-mapper, interrupts, QoS classes, statsd synthetic charts, etc.
128
+
129
+
130
+</details>
131
+
132
+#### Examples
133
+
134
+##### Example configuration
135
+
136
+Basic example configuration for Prometheus remote write.
137
+
138
+```yaml
139
+[prometheus_remote_write:my_instance]
140
+ enabled = yes
141
+ destination = 10.11.14.2:2003
142
+ remote write URL path = /receive
143
+
144
+```
145
+##### Example configuration with HTTPS and HTTP authentication
146
+
147
+Add `:https` modifier to the connector type if you need to use the TLS/SSL protocol. For example: `remote_write:https:my_instance`.
148
+
149
+```yaml
150
+[prometheus_remote_write:https:my_instance]
151
+ enabled = yes
152
+ destination = 10.11.14.2:2003
153
+ remote write URL path = /receive
154
+ username = my_username
155
+ password = my_password
156
+
157
+```
158
+