--- title: NATS integration description: This integration is used to collect logs and metrics from NATS servers. The integration collects metrics from NATS monitoring server APIs. The Nats package... url: https://www.elastic.co/docs/reference/integrations/nats products: - Elastic integrations applies_to: - Serverless Observability projects: Generally available - Serverless Security projects: Generally available - Elastic Stack: Generally available since 9.0 --- # NATS integration | | | |-------------------------------------------------------------------------------------------------|---------------------------------| | **Version** | 1.12.0 ([View all](#changelog)) | | **Subscription level**[What's this?](https://www.elastic.co/subscriptions) | Basic | | **Developed by**[What's this?](https://www.elastic.co/docs/reference/integrations/developed-by) | Elastic | | **Ingestion method(s)** | API, File | | **Minimum Kibana version(s)** | 9.0.08.13.0 | This integration is used to collect logs and metrics from [NATS servers](https://nats.io/). The integration collects metrics from [NATS monitoring server APIs](https://docs.nats.io/running-a-nats-service/nats_admin/monitoring). ## Compatibility The Nats package is tested with Nats 1.3.0, 2.0.4 and 2.1.4 ## Logs ### log The `log` dataset collects the NATS logs. ```json { "@timestamp": "2020-11-25T11:50:17.759Z", "agent": { "ephemeral_id": "4f1426bb-db10-4b5d-9e1c-ba6da401dc34", "hostname": "5706c620a165", "id": "25c804ef-d8c8-4a2e-9228-64213daef566", "name": "5706c620a165", "type": "filebeat", "version": "7.11.0" }, "client": { "ip": "192.168.192.3", "port": 53482 }, "data_stream": { "dataset": "nats.log", "namespace": "default", "type": "logs" }, "ecs": { "version": "8.11.0" }, "elastic_agent": { "id": "5a7b52c1-66ae-47ce-ad18-70dadf1bedfa", "snapshot": true, "version": "7.11.0" }, "event": { "created": "2020-11-25T11:53:04.192Z", "dataset": "nats.log", "ingested": "2020-11-25T11:53:10.021181400Z", "kind": "event", "type": [ "info" ] }, "host": { "architecture": "x86_64", "containerized": true, "hostname": "5706c620a165", "id": "06c26569966fd125c15acac5d7feffb6", "ip": [ "192.168.192.8" ], "mac": [ "02-42-C0-A8-F5-07" ], "name": "5706c620a165", "os": { "codename": "Core", "family": "redhat", "kernel": "4.9.184-linuxkit", "name": "CentOS Linux", "platform": "centos", "version": "7 (Core)" } }, "input": { "type": "log" }, "log": { "file": { "path": "/var/log/nats/nats.log" }, "level": "trace", "offset": 36865655 }, "nats": { "log": { "client": { "id": "86" }, "msg": { "type": "payload" } } }, "network": { "direction": "inbound" }, "process": { "pid": 6 }, "related": { "ip": [ "192.168.192.3" ] } } ``` **ECS Field Reference** Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields. | Field | Description | Type | |----------------------------|-------------------------------------------------------------------------------|------------------| | @timestamp | Event timestamp. | date | | data_stream.dataset | Data stream dataset. | constant_keyword | | data_stream.namespace | Data stream namespace. | constant_keyword | | data_stream.type | Data stream type. | constant_keyword | | event.dataset | Event dataset | constant_keyword | | event.module | Event module | constant_keyword | | input.type | Type of Filebeat input. | keyword | | log.offset | Offset of the entry in the log file. | long | | nats.log.client.id | The id of the client | integer | | nats.log.msg.bytes | Size of the payload in bytes | long | | nats.log.msg.error.message | Details about the error occurred | text | | nats.log.msg.max_messages | An optional number of messages to wait for before automatically unsubscribing | integer | | nats.log.msg.queue_group | The queue group which subscriber will join | text | | nats.log.msg.reply_to | The inbox subject on which the publisher is listening for responses | keyword | | nats.log.msg.sid | The unique alphanumeric subscription ID of the subject | integer | | nats.log.msg.subject | Subject name this message was received on | keyword | | nats.log.msg.type | The protocol message type | keyword | ## Metrics The default datasets are `stats`, `connections`, `routes` and `subscriptions` while `connection` and `route` datasets can be enabled to collect detailed metrics per connection/route. ### stats This is the `stats` dataset of the Nats package, in charge of retrieving generic metrics from a Nats instance. ```json { "@timestamp": "2024-06-18T06:49:17.492Z", "agent": { "ephemeral_id": "4b9c9086-97a0-4aec-9cc4-b227f25eaf7b", "id": "97400795-188c-4140-a1ee-0002078c785d", "name": "docker-fleet-agent", "type": "metricbeat", "version": "8.13.0" }, "data_stream": { "dataset": "nats.stats", "namespace": "ep", "type": "metrics" }, "ecs": { "version": "8.0.0" }, "elastic_agent": { "id": "97400795-188c-4140-a1ee-0002078c785d", "snapshot": false, "version": "8.13.0" }, "event": { "agent_id_status": "verified", "dataset": "nats.stats", "duration": 1739425, "ingested": "2024-06-18T06:49:29Z", "module": "nats" }, "host": { "architecture": "x86_64", "containerized": true, "hostname": "docker-fleet-agent", "id": "8259e024976a406e8a54cdbffeb84fec", "ip": [ "192.168.245.7" ], "mac": [ "02-42-C0-A8-F5-07" ], "name": "docker-fleet-agent", "os": { "codename": "focal", "family": "debian", "kernel": "3.10.0-1160.102.1.el7.x86_64", "name": "Ubuntu", "platform": "ubuntu", "type": "linux", "version": "20.04.6 LTS (Focal Fossa)" } }, "metricset": { "name": "stats", "period": 10000 }, "nats": { "server": { "id": "NDCZVPEIJLTFLUSYR6Y4OSKTDJ5QD4LTTBSOKJ6HPX3K3QZPF6CI6VMI", "time": "2024-06-18T06:49:17.492Z" }, "stats": { "cores": 12, "cpu": 1.03, "http": { "req_stats": { "uri": { "connz": 0, "root": 0, "routez": 0, "subsz": 0, "varz": 1 } } }, "in": { "bytes": 29849184, "messages": 1865574 }, "mem": { "bytes": 8806400 }, "out": { "bytes": 0, "messages": 0 }, "remotes": 1, "slow_consumers": 0, "total_connections": 1, "uptime": 13 } }, "service": { "address": "http://elastic-package-service-nats-1:8222/varz", "type": "nats" } } ``` **ECS Field Reference** Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields. | Field | Description | Type | Metric Type | |----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-------------| | @timestamp | Event timestamp. | date | | | agent.id | Unique identifier of this agent (if one exists). Example: For Beats this would be beat.id. | keyword | | | cloud.account.id | The cloud account or organization id used to identify different entities in a multi-tenant environment. Examples: AWS account id, Google Cloud ORG Id, or other unique identifier. | keyword | | | cloud.availability_zone | Availability zone in which this host, resource, or service is located. | keyword | | | cloud.instance.id | Instance ID of the host machine. | keyword | | | cloud.provider | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. | keyword | | | cloud.region | Region in which this host, resource, or service is located. | keyword | | | container.id | Unique container id. | keyword | | | data_stream.dataset | Data stream dataset. | constant_keyword | | | data_stream.namespace | Data stream namespace. | constant_keyword | | | data_stream.type | Data stream type. | constant_keyword | | | event.dataset | Event dataset | constant_keyword | | | event.module | Event module | constant_keyword | | | host.name | Name of the host. It can contain what hostname returns on Unix systems, the fully qualified domain name (FQDN), or a name specified by the user. The recommended value is the lowercase FQDN of the host. | keyword | | | nats.server.id | The server ID | keyword | | | nats.server.time | Server time of metric creation | date | | | nats.stats.cores | The number of logical cores the NATS process runs on | integer | gauge | | nats.stats.cpu | The current cpu usage of NATs process | scaled_float | gauge | | nats.stats.http.req_stats.uri.connz | The number of hits on connz monitoring uri | long | counter | | nats.stats.http.req_stats.uri.gatewayz | The number of hits on gatewayz monitoring uri | long | counter | | nats.stats.http.req_stats.uri.root | The number of hits on root monitoring uri | long | counter | | nats.stats.http.req_stats.uri.routez | The number of hits on routez monitoring uri | long | counter | | nats.stats.http.req_stats.uri.subsz | The number of hits on subsz monitoring uri | long | counter | | nats.stats.http.req_stats.uri.varz | The number of hits on varz monitoring uri | long | counter | | nats.stats.in.bytes | The amount of incoming bytes | long | counter | | nats.stats.in.messages | The amount of incoming messages | long | counter | | nats.stats.mem.bytes | The current memory usage of NATS process | long | gauge | | nats.stats.out.bytes | The amount of outgoing bytes | long | counter | | nats.stats.out.messages | The amount of outgoing messages | long | counter | | nats.stats.remotes | The number of registered remotes | integer | gauge | | nats.stats.slow_consumers | The number of slow consumers currently on NATS | long | gauge | | nats.stats.total_connections | The number of totally created clients | long | counter | | nats.stats.uptime | The period the server is up (sec) | long | counter | | nats.stats.version | The specifies version. | keyword | | | service.address | Address where data about this service was collected from. This should be a URI, network address (ipv4:port or [ipv6]:port) or a resource path (sockets). | keyword | | ### connections This is the `connections` dataset of the Nats package, in charge of retrieving generic metrics about connections from a Nats instance. ```json { "@timestamp": "2024-06-18T06:42:06.763Z", "agent": { "ephemeral_id": "dd10a7db-f158-4b9b-aaf2-af4cdc3d6b06", "id": "97400795-188c-4140-a1ee-0002078c785d", "name": "docker-fleet-agent", "type": "metricbeat", "version": "8.13.0" }, "data_stream": { "dataset": "nats.connections", "namespace": "ep", "type": "metrics" }, "ecs": { "version": "8.0.0" }, "elastic_agent": { "id": "97400795-188c-4140-a1ee-0002078c785d", "snapshot": false, "version": "8.13.0" }, "event": { "agent_id_status": "verified", "dataset": "nats.connections", "duration": 1514602, "ingested": "2024-06-18T06:42:18Z", "module": "nats" }, "host": { "architecture": "x86_64", "containerized": true, "hostname": "docker-fleet-agent", "id": "8259e024976a406e8a54cdbffeb84fec", "ip": [ "192.168.245.7" ], "mac": [ "02-42-C0-A8-F5-07" ], "name": "docker-fleet-agent", "os": { "codename": "focal", "family": "debian", "kernel": "3.10.0-1160.102.1.el7.x86_64", "name": "Ubuntu", "platform": "ubuntu", "type": "linux", "version": "20.04.6 LTS (Focal Fossa)" } }, "metricset": { "name": "connections", "period": 10000 }, "nats": { "connections": { "total": 1 }, "server": { "id": "NCNKDXBFQLH5L4U6H3BPZX2CYTOLLFFFKKMAPUCSKE2QYMMS2S7HGYMN", "time": "2024-06-18T06:42:06.763Z" } }, "service": { "address": "http://elastic-package-service-nats-1:8222/connz", "type": "nats" } } ``` **ECS Field Reference** Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields. | Field | Description | Type | Metric Type | |-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-------------| | @timestamp | Event timestamp. | date | | | agent.id | Unique identifier of this agent (if one exists). Example: For Beats this would be beat.id. | keyword | | | cloud.account.id | The cloud account or organization id used to identify different entities in a multi-tenant environment. Examples: AWS account id, Google Cloud ORG Id, or other unique identifier. | keyword | | | cloud.availability_zone | Availability zone in which this host, resource, or service is located. | keyword | | | cloud.instance.id | Instance ID of the host machine. | keyword | | | cloud.provider | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. | keyword | | | cloud.region | Region in which this host, resource, or service is located. | keyword | | | container.id | Unique container id. | keyword | | | data_stream.dataset | Data stream dataset. | constant_keyword | | | data_stream.namespace | Data stream namespace. | constant_keyword | | | data_stream.type | Data stream type. | constant_keyword | | | event.dataset | Event dataset | constant_keyword | | | event.module | Event module | constant_keyword | | | host.name | Name of the host. It can contain what hostname returns on Unix systems, the fully qualified domain name (FQDN), or a name specified by the user. The recommended value is the lowercase FQDN of the host. | keyword | | | nats.connections.total | The number of currently active clients | integer | gauge | | nats.server.id | The server ID | keyword | | | nats.server.time | Server time of metric creation | date | | | service.address | Address where data about this service was collected from. This should be a URI, network address (ipv4:port or [ipv6]:port) or a resource path (sockets). | keyword | | ### routes This is the `routes` dataset of the Nats package, in charge of retrieving generic metrics about routes from a Nats instance. ```json { "@timestamp": "2024-06-18T06:46:57.937Z", "agent": { "ephemeral_id": "109393c6-0e20-4b2a-b653-3fa5e35b5f7c", "id": "97400795-188c-4140-a1ee-0002078c785d", "name": "docker-fleet-agent", "type": "metricbeat", "version": "8.13.0" }, "data_stream": { "dataset": "nats.routes", "namespace": "ep", "type": "metrics" }, "ecs": { "version": "8.0.0" }, "elastic_agent": { "id": "97400795-188c-4140-a1ee-0002078c785d", "snapshot": false, "version": "8.13.0" }, "event": { "agent_id_status": "verified", "dataset": "nats.routes", "duration": 1390061, "ingested": "2024-06-18T06:47:09Z", "module": "nats" }, "host": { "architecture": "x86_64", "containerized": true, "hostname": "docker-fleet-agent", "id": "8259e024976a406e8a54cdbffeb84fec", "ip": [ "192.168.245.7" ], "mac": [ "02-42-C0-A8-F5-07" ], "name": "docker-fleet-agent", "os": { "codename": "focal", "family": "debian", "kernel": "3.10.0-1160.102.1.el7.x86_64", "name": "Ubuntu", "platform": "ubuntu", "type": "linux", "version": "20.04.6 LTS (Focal Fossa)" } }, "metricset": { "name": "routes", "period": 10000 }, "nats": { "routes": { "total": 1 }, "server": { "id": "NCTCCFMHSIRDQEDRY54BNE6H5D2S476BITJEDHPZMOMCKZOITM6WWA6V", "time": "2024-06-18T06:46:57.937Z" } }, "service": { "address": "http://elastic-package-service-nats-1:8222/routez", "type": "nats" } } ``` **ECS Field Reference** Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields. | Field | Description | Type | Metric Type | |-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-------------| | @timestamp | Event timestamp. | date | | | agent.id | Unique identifier of this agent (if one exists). Example: For Beats this would be beat.id. | keyword | | | cloud.account.id | The cloud account or organization id used to identify different entities in a multi-tenant environment. Examples: AWS account id, Google Cloud ORG Id, or other unique identifier. | keyword | | | cloud.availability_zone | Availability zone in which this host, resource, or service is located. | keyword | | | cloud.instance.id | Instance ID of the host machine. | keyword | | | cloud.provider | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. | keyword | | | cloud.region | Region in which this host, resource, or service is located. | keyword | | | container.id | Unique container id. | keyword | | | data_stream.dataset | Data stream dataset. | constant_keyword | | | data_stream.namespace | Data stream namespace. | constant_keyword | | | data_stream.type | Data stream type. | constant_keyword | | | event.dataset | Event dataset | constant_keyword | | | event.module | Event module | constant_keyword | | | host.name | Name of the host. It can contain what hostname returns on Unix systems, the fully qualified domain name (FQDN), or a name specified by the user. The recommended value is the lowercase FQDN of the host. | keyword | | | nats.routes.total | The number of registered routes | integer | gauge | | nats.server.id | The server ID | keyword | | | nats.server.time | Server time of metric creation | date | | | service.address | Address where data about this service was collected from. This should be a URI, network address (ipv4:port or [ipv6]:port) or a resource path (sockets). | keyword | | ### subscriptions This is the `subscriptions` dataset of the Nats package, in charge of retrieving metrics about subscriptions from a Nats instance. ```json { "@timestamp": "2024-06-18T06:51:43.719Z", "agent": { "ephemeral_id": "20d397d4-1143-4670-8a66-d8b8bceb57ac", "id": "97400795-188c-4140-a1ee-0002078c785d", "name": "docker-fleet-agent", "type": "metricbeat", "version": "8.13.0" }, "data_stream": { "dataset": "nats.subscriptions", "namespace": "ep", "type": "metrics" }, "ecs": { "version": "8.0.0" }, "elastic_agent": { "id": "97400795-188c-4140-a1ee-0002078c785d", "snapshot": false, "version": "8.13.0" }, "event": { "agent_id_status": "verified", "dataset": "nats.subscriptions", "duration": 1163583, "ingested": "2024-06-18T06:51:55Z", "module": "nats" }, "host": { "architecture": "x86_64", "containerized": true, "hostname": "docker-fleet-agent", "id": "8259e024976a406e8a54cdbffeb84fec", "ip": [ "192.168.245.7" ], "mac": [ "02-42-C0-A8-F5-07" ], "name": "docker-fleet-agent", "os": { "codename": "focal", "family": "debian", "kernel": "3.10.0-1160.102.1.el7.x86_64", "name": "Ubuntu", "platform": "ubuntu", "type": "linux", "version": "20.04.6 LTS (Focal Fossa)" } }, "metricset": { "name": "subscriptions", "period": 10000 }, "nats": { "subscriptions": { "cache": { "fanout": { "avg": 0, "max": 0 }, "hit_rate": 0, "size": 1 }, "inserts": 0, "matches": 1, "removes": 0, "total": 0 } }, "service": { "address": "http://elastic-package-service-nats-1:8222/subsz", "type": "nats" } } ``` **ECS Field Reference** Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields. | Field | Description | Type | Metric Type | |-------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-------------| | @timestamp | Event timestamp. | date | | | agent.id | Unique identifier of this agent (if one exists). Example: For Beats this would be beat.id. | keyword | | | cloud.account.id | The cloud account or organization id used to identify different entities in a multi-tenant environment. Examples: AWS account id, Google Cloud ORG Id, or other unique identifier. | keyword | | | cloud.availability_zone | Availability zone in which this host, resource, or service is located. | keyword | | | cloud.instance.id | Instance ID of the host machine. | keyword | | | cloud.provider | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. | keyword | | | cloud.region | Region in which this host, resource, or service is located. | keyword | | | container.id | Unique container id. | keyword | | | data_stream.dataset | Data stream dataset. | constant_keyword | | | data_stream.namespace | Data stream namespace. | constant_keyword | | | data_stream.type | Data stream type. | constant_keyword | | | event.dataset | Event dataset | constant_keyword | | | event.module | Event module | constant_keyword | | | host.name | Name of the host. It can contain what hostname returns on Unix systems, the fully qualified domain name (FQDN), or a name specified by the user. The recommended value is the lowercase FQDN of the host. | keyword | | | nats.server.id | The server ID | keyword | | | nats.server.time | Server time of metric creation | date | | | nats.subscriptions.cache.fanout.avg | The average fanout served by cache | double | gauge | | nats.subscriptions.cache.fanout.max | The maximum fanout served by cache | integer | gauge | | nats.subscriptions.cache.hit_rate | The rate matches are being retrieved from cache | scaled_float | gauge | | nats.subscriptions.cache.size | The number of result sets in the cache | integer | gauge | | nats.subscriptions.inserts | The number of insert operations in subscriptions list | long | counter | | nats.subscriptions.matches | The number of times a match is found for a subscription | long | counter | | nats.subscriptions.removes | The number of remove operations in subscriptions list | long | counter | | nats.subscriptions.total | The number of active subscriptions | integer | gauge | | service.address | Address where data about this service was collected from. This should be a URI, network address (ipv4:port or [ipv6]:port) or a resource path (sockets). | keyword | | ### connection This is the `connection` dataset of the Nats package, in charge of retrieving detailed metrics per connection from a Nats instance. ```json { "@timestamp": "2024-06-18T06:39:34.665Z", "agent": { "ephemeral_id": "3565b6dd-89b9-4d31-bc0e-52bd652289ee", "id": "97400795-188c-4140-a1ee-0002078c785d", "name": "docker-fleet-agent", "type": "metricbeat", "version": "8.13.0" }, "data_stream": { "dataset": "nats.connection", "namespace": "ep", "type": "metrics" }, "ecs": { "version": "8.0.0" }, "elastic_agent": { "id": "97400795-188c-4140-a1ee-0002078c785d", "snapshot": false, "version": "8.13.0" }, "event": { "agent_id_status": "verified", "dataset": "nats.connection", "duration": 1778759, "ingested": "2024-06-18T06:39:46Z", "module": "nats" }, "host": { "architecture": "x86_64", "containerized": true, "hostname": "docker-fleet-agent", "id": "8259e024976a406e8a54cdbffeb84fec", "ip": [ "192.168.245.7" ], "mac": [ "02-42-C0-A8-F5-07" ], "name": "docker-fleet-agent", "os": { "codename": "focal", "family": "debian", "kernel": "3.10.0-1160.102.1.el7.x86_64", "name": "Ubuntu", "platform": "ubuntu", "type": "linux", "version": "20.04.6 LTS (Focal Fossa)" } }, "metricset": { "name": "connection", "period": 10000 }, "nats": { "connection": { "idle_time": 0, "in": { "bytes": 31946336, "messages": 1996646 }, "name": "NATS Benchmark", "out": { "bytes": 0, "messages": 0 }, "pending_bytes": 0, "subscriptions": 0, "uptime": 14 }, "server": { "id": "NCKVGU7EX4KDOQDL6CQIEYBWSAVCA37KXRD5UOGRNGIFXOMDAV3VYKFJ" } }, "service": { "address": "http://elastic-package-service-nats-1:8222/connz", "type": "nats" } } ``` **ECS Field Reference** Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields. | Field | Description | Type | Metric Type | |-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-------------| | @timestamp | Event timestamp. | date | | | agent.id | Unique identifier of this agent (if one exists). Example: For Beats this would be beat.id. | keyword | | | cloud.account.id | The cloud account or organization id used to identify different entities in a multi-tenant environment. Examples: AWS account id, Google Cloud ORG Id, or other unique identifier. | keyword | | | cloud.availability_zone | Availability zone in which this host, resource, or service is located. | keyword | | | cloud.instance.id | Instance ID of the host machine. | keyword | | | cloud.provider | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. | keyword | | | cloud.region | Region in which this host, resource, or service is located. | keyword | | | container.id | Unique container id. | keyword | | | data_stream.dataset | Data stream dataset. | constant_keyword | | | data_stream.namespace | Data stream namespace. | constant_keyword | | | data_stream.type | Data stream type. | constant_keyword | | | event.dataset | Event dataset | constant_keyword | | | event.module | Event module | constant_keyword | | | host.name | Name of the host. It can contain what hostname returns on Unix systems, the fully qualified domain name (FQDN), or a name specified by the user. The recommended value is the lowercase FQDN of the host. | keyword | | | nats.connection.id | A unique numeric identifier assigned by the NATS server to a connection | keyword | | | nats.connection.idle_time | The period the connection is idle (sec) | long | counter | | nats.connection.in.bytes | The amount of incoming bytes | long | counter | | nats.connection.in.messages | The amount of incoming messages | long | counter | | nats.connection.ip | The ip of the connection | ip | | | nats.connection.lang | Language of the file. | keyword | | | nats.connection.last_activity | The timestamp of the last activity on this connection | date | | | nats.connection.name | The name of the connection | keyword | | | nats.connection.out.bytes | The amount of outgoing bytes | long | counter | | nats.connection.out.messages | The amount of outgoing messages | long | counter | | nats.connection.pending_bytes | The number of pending bytes of this connection | long | gauge | | nats.connection.port | The port of the connection | integer | | | nats.connection.start | The timestamp when the connection was established | date | | | nats.connection.subscriptions | The number of subscriptions in this connection | integer | gauge | | nats.connection.uptime | The period the connection is up (sec) | long | counter | | nats.connection.version | The specifies version | keyword | | | nats.server.id | The server ID | keyword | | | nats.server.time | Server time of metric creation | date | | | service.address | Address where data about this service was collected from. This should be a URI, network address (ipv4:port or [ipv6]:port) or a resource path (sockets). | keyword | | ### route This is the `route` dataset of the Nats package, in charge of retrieving detailed metric per route from a Nats instance. ```json { "@timestamp": "2024-06-18T06:44:35.066Z", "agent": { "ephemeral_id": "6003d8f1-6313-4eb7-8d62-101876d13951", "id": "97400795-188c-4140-a1ee-0002078c785d", "name": "docker-fleet-agent", "type": "metricbeat", "version": "8.13.0" }, "data_stream": { "dataset": "nats.route", "namespace": "ep", "type": "metrics" }, "ecs": { "version": "8.0.0" }, "elastic_agent": { "id": "97400795-188c-4140-a1ee-0002078c785d", "snapshot": false, "version": "8.13.0" }, "event": { "agent_id_status": "verified", "dataset": "nats.route", "duration": 1372502, "ingested": "2024-06-18T06:44:47Z", "module": "nats" }, "host": { "architecture": "x86_64", "containerized": true, "hostname": "docker-fleet-agent", "id": "8259e024976a406e8a54cdbffeb84fec", "ip": [ "192.168.245.7" ], "mac": [ "02-42-C0-A8-F5-07" ], "name": "docker-fleet-agent", "os": { "codename": "focal", "family": "debian", "kernel": "3.10.0-1160.102.1.el7.x86_64", "name": "Ubuntu", "platform": "ubuntu", "type": "linux", "version": "20.04.6 LTS (Focal Fossa)" } }, "metricset": { "name": "route", "period": 10000 }, "nats": { "route": { "in": { "bytes": 0, "messages": 0 }, "ip": "192.168.254.2", "out": { "bytes": 0, "messages": 0 }, "pending_size": 0, "port": 43212, "remote_id": "NDLBUBM32KU4PB6T3NDNQOFUCNPVHPGEVLS5K2CYY2RHGOV6M3UBBXCF", "subscriptions": 0 }, "server": { "id": "NADJLTRJXDJIDP4EJTJ2ZLIYQENQKIRX23VYDPNGHPAWEAHLESEEENNM" } }, "service": { "address": "http://elastic-package-service-nats-1:8222/routez", "type": "nats" } } ``` **ECS Field Reference** Please refer to the following [document](https://www.elastic.co/guide/en/ecs/current/ecs-field-reference.html) for detailed information on ECS fields. | Field | Description | Type | Metric Type | |--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------|-------------| | @timestamp | Event timestamp. | date | | | agent.id | Unique identifier of this agent (if one exists). Example: For Beats this would be beat.id. | keyword | | | cloud.account.id | The cloud account or organization id used to identify different entities in a multi-tenant environment. Examples: AWS account id, Google Cloud ORG Id, or other unique identifier. | keyword | | | cloud.availability_zone | Availability zone in which this host, resource, or service is located. | keyword | | | cloud.instance.id | Instance ID of the host machine. | keyword | | | cloud.provider | Name of the cloud provider. Example values are aws, azure, gcp, or digitalocean. | keyword | | | cloud.region | Region in which this host, resource, or service is located. | keyword | | | container.id | Unique container id. | keyword | | | data_stream.dataset | Data stream dataset. | constant_keyword | | | data_stream.namespace | Data stream namespace. | constant_keyword | | | data_stream.type | Data stream type. | constant_keyword | | | event.dataset | Event dataset | constant_keyword | | | event.module | Event module | constant_keyword | | | host.name | Name of the host. It can contain what hostname returns on Unix systems, the fully qualified domain name (FQDN), or a name specified by the user. The recommended value is the lowercase FQDN of the host. | keyword | | | nats.route.in.bytes | The amount of incoming bytes | long | counter | | nats.route.in.messages | The amount of incoming messages | long | counter | | nats.route.ip | The ip of the route | ip | | | nats.route.out.bytes | The amount of outgoing bytes | long | counter | | nats.route.out.messages | The amount of outgoing messages | long | counter | | nats.route.pending_size | The number of pending routes | long | gauge | | nats.route.port | The port of the route | integer | | | nats.route.remote_id | The remote id on which the route is connected to | keyword | | | nats.route.subscriptions | The number of subscriptions in this connection | integer | gauge | | nats.server.id | The server ID | keyword | | | nats.server.time | Server time of metric creation | date | | | service.address | Address where data about this service was collected from. This should be a URI, network address (ipv4:port or [ipv6]:port) or a resource path (sockets). | keyword | | ## Screenshots This integration includes one or more Kibana dashboards that visualizes the data collected by the integration. The screenshots below illustrate how the ingested data is displayed. ![Filebeat NATS Dashboard](https://epr.elastic.co/package/nats/1.12.0/img/filebeat_nats_dashboard.png) ![Metricbeat NATS Dashboard](https://epr.elastic.co/package/nats/1.12.0/img/metricbeat_nats_dashboard.png) ## Changelog | Version | Details | Minimum Kibana version | |------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------| | **1.12.0** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/16639))Add missing fields to `connection` and `stats` data datastreams. | 9.0.08.13.0 | | **1.11.0** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/13518))Allow @custom pipeline access to event.original without setting preserve_original_event. | 9.0.08.13.0 | | **1.10.0** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/issues/13124))Update format to spec 3.0 | 9.0.08.13.0 | | **1.9.0** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/12475))Add support for Kibana `9.0.0`. | 9.0.08.13.0 | | **1.8.0** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/12503))Allow the usage of deprecated log input and support for stack 9.0 | 8.13.0 | | **1.7.0** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/10171))ECS version updated to 8.11.0. Update the kibana constraint to ^8.13.0. Modified the field definitions to remove ECS fields made redundant by the ecs@mappings component template. | 8.13.0 | | **1.6.0** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/9869))Add global filter on data_stream.dataset to improve performance. | 8.10.2 | | **1.5.1** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/8383))Migrate `Client IP Count Timeline` visualization to lens. | 8.10.2 | | **1.5.0** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/8243))Enable time series data for metrics data streams. This dramatically reduces storage for metrics and is expected to progressively improve query [performance](https://www.elastic.co/blog/70-percent-storage-savings-for-metrics-with-elastic-observability). For more details, see [https://www.elastic.co/guide/en/elasticsearch/reference/current/tsds.html](https://www.elastic.co/guide/en/elasticsearch/reference/current/tsds.html). | 8.10.2 | | **1.4.4** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/7744))Add dimensions, metric_type mappings and additional ECS fields to routes data stream. | 8.10.2 | | **1.4.3** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/7749))Add metric_type mappings to the subscriptions data stream. | 8.10.2 | | **1.4.2** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/7748))Add dimensions mappings and additional ECS fields to subscriptions data stream. | 8.10.2 | | **1.4.1** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/7747))Add metric_type mappings to stats data stream. | 8.10.2 | | **1.4.0** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/7746))Add dimensions mappings and additional ECS fields to stats data stream. | 8.10.2 | | **1.3.9** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/7743))Add metric_type mapping to route data stream. | 8.10.2 | | **1.3.8** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/7742))Add route data stream dimensions and additional ECS fields. | 8.10.2 | | **1.3.7** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/7741))Add dimensions and metric_type mappings to connections data stream. | 8.10.2 | | **1.3.6** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/7740))Add connection data stream metric types. | 8.10.2 | | **1.3.5** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/7739))Add dimensions mapping to connection data stream. | 8.10.2 | | **1.3.4** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/8126))Migrate Metrics Overview dashboard visualizations to lens. | 8.10.2 | | **1.3.3** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/8086))Migrate Logs Overview dashboard visualizations to lens. | 8.10.2 | | **1.3.2** | **Bug fix** ([View pull request](https://github.com/elastic/integrations/pull/7956))Add null check to the rename processor | 8.0.07.14.0 | | **1.3.1** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/5123))Added categories and/or subcategories. | 8.0.07.14.0 | | **1.3.0** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/2504))Update to ECS 8.0 | 8.0.07.14.0 | | **1.2.1** | **Bug fix** ([View pull request](https://github.com/elastic/integrations/pull/2327))Change test public IPs to the supported subset | | | **1.2.0** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/2168))Release nats package for v8.0.0 | 8.0.07.14.0 | | **1.1.2** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/2054))Uniform with guidelines | | | **1.1.1** | **Bug fix** ([View pull request](https://github.com/elastic/integrations/pull/1832))Fix logic that checks for the 'forwarded' tag | | | **1.1.0** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/1700))Update to ECS 1.12.0 | 7.14.0 | | **1.0.0** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/1613))Release NATS as GA | | | **0.5.3** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/1488))Convert to generated ECS fields | | | **0.5.2** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/1395))update to ECS 1.11.0 | | | **0.5.1** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/1405))Escape special characters in docs | | | **0.5.0** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/1364))Update integration description | | | **0.4.0** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/1229))Set "event.module" and "event.dataset" | | | **0.3.0** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/1061))update to ECS 1.10.0 and add event.original options | | | **0.2.0** | **Bug fix** ([View pull request](https://github.com/elastic/integrations/pull/996))Fix stack compatability | | | **0.1.4** | **Bug fix** ([View pull request](https://github.com/elastic/integrations/pull/957))Fix filters on dashboards | | | **0.1.3** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/766))Updating package owner**Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/856))update to ECS 1.9.0 | | | **0.1.2** | **Bug fix** ([View pull request](https://github.com/elastic/integrations/pull/754))Correct sample event file. | | | **0.1.1** | **Bug fix** ([View pull request](https://github.com/elastic/integrations/pull/749))Change kibana.version constraint to be more conservative. | | | **0.1.0** | **Enhancement** ([View pull request](https://github.com/elastic/integrations/pull/413))initial release | |