-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
README.md
49 lines (37 loc) · 2.9 KB
/
README.md
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
# Aerospike Receiver
<!-- status autogenerated section -->
| Status | |
| ------------- |-----------|
| Stability | [alpha]: metrics |
| Distributions | [contrib] |
| Issues | [](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aopen+is%3Aissue+label%3Areceiver%2Faerospike) [](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aclosed+is%3Aissue+label%3Areceiver%2Faerospike) |
| [Code Owners](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#becoming-a-code-owner) | [@djaglowski](https://www.github.com/djaglowski), [@antonblock](https://www.github.com/antonblock) \| Seeking more code owners! |
[alpha]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#alpha
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->
The Aerospike receiver is designed to collect performance metrics from one or
more Aerospike nodes. It uses the
[official Go client](https://github.com/aerospike/aerospike-client-go/tree/v5/)
to connect and collect.
Aerospike versions 4.9, 5.x, and 6.x are supported.
## Configuration
Configuration parameters:
- `endpoint` (default localhost:3000): Aerospike host ex: 127.0.0.1:3000.
- `tlsname` Endpoint tls name. Used by the client during TLS connections. See [Aerospike authentication](https://docs.aerospike.com/server/guide/security/tls#standard-authentication) for mor details.
- `collect_cluster_metrics` (default false): Whether discovered peer nodes should be collected.
- `collection_interval` (default = 60s): This receiver collects metrics on an interval. Valid time units are ns, us (or µs), ms, s, m, h.
- `initial_delay` (default = `1s`): defines how long this receiver waits before starting.
- `username` (Enterprise Edition only.)
- `password` (Enterprise Edition only.)
- `tls` (default empty/no tls) tls configuration for connection to Aerospike nodes. More information at [OpenTelemetry's tls config page](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md).
### Example Configuration
```yaml
receivers:
aerospike:
endpoint: "localhost:3000"
tlsname: ""
collect_cluster_metrics: false
collection_interval: 30s
```
## Metrics
Details about the metrics produced by this receiver can be found in [metadata.yaml](./metadata.yaml)