Skip to content

Commit

Permalink
Regenerate integrations docs (netdata#19254)
Browse files Browse the repository at this point in the history
Co-authored-by: ilyam8 <[email protected]>
  • Loading branch information
netdatabot and ilyam8 authored Dec 19, 2024
1 parent 48ad16e commit 230f0a8
Show file tree
Hide file tree
Showing 3 changed files with 286 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/collectors/COLLECTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -785,6 +785,8 @@ If you don't see the app/service you'd like to monitor in this list:

- [MQTT Blackbox](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/mqtt_blackbox.md)

- [NATS](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/nats/integrations/nats.md)

- [RabbitMQ](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/rabbitmq/integrations/rabbitmq.md)

- [Redis Queue](https://github.com/netdata/netdata/blob/master/src/go/plugin/go.d/collector/prometheus/integrations/redis_queue.md)
Expand Down
1 change: 1 addition & 0 deletions src/go/plugin/go.d/collector/nats/README.md
283 changes: 283 additions & 0 deletions src/go/plugin/go.d/collector/nats/integrations/nats.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,283 @@
<!--startmeta
custom_edit_url: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/nats/README.md"
meta_yaml: "https://github.com/netdata/netdata/edit/master/src/go/plugin/go.d/collector/nats/metadata.yaml"
sidebar_label: "NATS"
learn_status: "Published"
learn_rel_path: "Collecting Metrics/Message Brokers"
most_popular: False
message: "DO NOT EDIT THIS FILE DIRECTLY, IT IS GENERATED BY THE COLLECTOR'S metadata.yaml FILE"
endmeta-->

# NATS


<img src="https://netdata.cloud/img/nats.svg" width="150"/>


Plugin: go.d.plugin
Module: nats

<img src="https://img.shields.io/badge/maintained%20by-Netdata-%2300ab44" />

## Overview

This collector monitors the activity and performance of NATS servers.


It sends HTTP requests to the NATS HTTP server's dedicated [monitoring port](https://docs.nats.io/running-a-nats-service/nats_admin/monitoring#monitoring-nats).


This collector is supported on all platforms.

This collector supports collecting metrics from multiple instances of this integration, including remote instances.


### Default Behavior

#### Auto-Detection

The collector can automatically detect NATS instances running on:

- localhost that are listening on port 8222
- within Docker containers


#### Limits

The default configuration for this integration does not impose any limits on data collection.

#### Performance Impact

The default configuration for this integration is not expected to impose a significant performance impact on the system.


## Metrics

Metrics grouped by *scope*.

The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.



### Per server

These metrics refer to NATS servers.

This scope has no labels.

Metrics:

| Metric | Dimensions | Unit |
|:------|:----------|:----|
| nats.server_traffic | in, out | bytes/s |
| nats.server_messages | in, out | messages/s |
| nats.server_connections_current | active | connections |
| nats.server_connections_rate | connections | connections/s |
| nats.server_health_probe_status | ok, error | status |
| nats.server_cpu_usage | used | percent |
| nats.server_mem_usage | used | bytes |
| nats.server_uptime | uptime | seconds |

### Per http endpoint

These metrics refer to HTTP endpoints.

Labels:

| Label | Description |
|:-----------|:----------------|
| http_endpoint | HTTP endpoint path. |

Metrics:

| Metric | Dimensions | Unit |
|:------|:----------|:----|
| nats.http_endpoint_requests | requests | requests/s |



## Alerts

There are no alerts configured by default for this integration.


## Setup

### Prerequisites

#### Enable NATS monitoring

See [Enable monitoring](https://docs.nats.io/running-a-nats-service/nats_admin/monitoring#enabling-monitoring).



### Configuration

#### File

The configuration file name for this integration is `go.d/nats.conf`.


You can edit the configuration file using the [`edit-config`](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#edit-a-configuration-file-using-edit-config) script from the
Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/netdata-agent/configuration/README.md#the-netdata-config-directory).

```bash
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/nats.conf
```
#### Options

The following options can be defined globally: update_every, autodetection_retry.


<details open><summary>Config options</summary>

| Name | Description | Default | Required |
|:----|:-----------|:-------|:--------:|
| update_every | Data collection frequency. | 1 | no |
| autodetection_retry | Recheck interval in seconds. Zero means no recheck will be scheduled. | 0 | no |
| url | Server URL. | http://127.0.0.1:8222 | yes |
| timeout | HTTP request timeout. | 1 | no |
| username | Username for basic HTTP authentication. | | no |
| password | Password for basic HTTP authentication. | | no |
| proxy_url | Proxy URL. | | no |
| proxy_username | Username for proxy basic HTTP authentication. | | no |
| proxy_password | Password for proxy basic HTTP authentication. | | no |
| method | HTTP request method. | GET | no |
| body | HTTP request body. | | no |
| headers | HTTP request headers. | | no |
| not_follow_redirects | Redirect handling policy. Controls whether the client follows redirects. | no | no |
| tls_skip_verify | Server certificate chain and hostname validation policy. Controls whether the client performs this check. | no | no |
| tls_ca | Certification authority that the client uses when verifying the server's certificates. | | no |
| tls_cert | Client TLS certificate. | | no |
| tls_key | Client TLS key. | | no |

</details>

#### Examples

##### Basic

A basic example configuration.

```yaml
jobs:
- name: local
url: http://127.0.0.1:8222

```
##### HTTP authentication

Basic HTTP authentication.

<details open><summary>Config</summary>

```yaml
jobs:
- name: local
url: http://127.0.0.1:8222
username: username
password: password

```
</details>

##### HTTPS with self-signed certificate

NATS with enabled HTTPS and self-signed certificate.

<details open><summary>Config</summary>

```yaml
jobs:
- name: local
url: http://127.0.0.1:8222
tls_skip_verify: yes

```
</details>

##### Multi-instance

> **Note**: When you define multiple jobs, their names must be unique.
Collecting metrics from local and remote instances.


<details open><summary>Config</summary>

```yaml
jobs:
- name: local
url: http://127.0.0.1:8222

- name: remote
url: http://192.0.2.1:8222

```
</details>



## Troubleshooting

### Debug Mode

**Important**: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.

To troubleshoot issues with the `nats` collector, run the `go.d.plugin` with the debug option enabled. The output
should give you clues as to why the collector isn't working.

- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on
your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`.

```bash
cd /usr/libexec/netdata/plugins.d/
```

- Switch to the `netdata` user.

```bash
sudo -u netdata -s
```

- Run the `go.d.plugin` to debug the collector:

```bash
./go.d.plugin -d -m nats
```

### Getting Logs

If you're encountering problems with the `nats` collector, follow these steps to retrieve logs and identify potential issues:

- **Run the command** specific to your system (systemd, non-systemd, or Docker container).
- **Examine the output** for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.

#### System with systemd

Use the following command to view logs generated since the last Netdata service restart:

```bash
journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep nats
```

#### System without systemd

Locate the collector log file, typically at `/var/log/netdata/collector.log`, and use `grep` to filter for collector's name:

```bash
grep nats /var/log/netdata/collector.log
```

**Note**: This method shows logs from all restarts. Focus on the **latest entries** for troubleshooting current issues.

#### Docker Container

If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:

```bash
docker logs netdata 2>&1 | grep nats
```


0 comments on commit 230f0a8

Please sign in to comment.