diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 7361bdde9fa..3be7aa95a6e 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -339,6 +339,7 @@ /packages/nginx_ingress_controller @elastic/obs-ds-hosted-services /packages/nginx_ingress_controller_otel @elastic/obs-infraobs-integrations /packages/nginx_otel @elastic/obs-infraobs-integrations +/packages/nginx_input_otel @elastic/obs-infraobs-integrations /packages/nozomi_networks @elastic/security-service-integrations /packages/nvidia_gpu @elastic/obs-infraobs-integrations /packages/o365 @elastic/security-service-integrations diff --git a/packages/nginx_input_otel/LICENSE.txt b/packages/nginx_input_otel/LICENSE.txt new file mode 100644 index 00000000000..809108b857f --- /dev/null +++ b/packages/nginx_input_otel/LICENSE.txt @@ -0,0 +1,93 @@ +Elastic License 2.0 + +URL: https://www.elastic.co/licensing/elastic-license + +## Acceptance + +By using the software, you agree to all of the terms and conditions below. + +## Copyright License + +The licensor grants you a non-exclusive, royalty-free, worldwide, +non-sublicensable, non-transferable license to use, copy, distribute, make +available, and prepare derivative works of the software, in each case subject to +the limitations and conditions below. + +## Limitations + +You may not provide the software to third parties as a hosted or managed +service, where the service provides users with access to any substantial set of +the features or functionality of the software. + +You may not move, change, disable, or circumvent the license key functionality +in the software, and you may not remove or obscure any functionality in the +software that is protected by the license key. + +You may not alter, remove, or obscure any licensing, copyright, or other notices +of the licensor in the software. Any use of the licensor’s trademarks is subject +to applicable law. + +## Patents + +The licensor grants you a license, under any patent claims the licensor can +license, or becomes able to license, to make, have made, use, sell, offer for +sale, import and have imported the software, in each case subject to the +limitations and conditions in this license. This license does not cover any +patent claims that you cause to be infringed by modifications or additions to +the software. If you or your company make any written claim that the software +infringes or contributes to infringement of any patent, your patent license for +the software granted under these terms ends immediately. If your company makes +such a claim, your patent license ends immediately for work on behalf of your +company. + +## Notices + +You must ensure that anyone who gets a copy of any part of the software from you +also gets a copy of these terms. + +If you modify the software, you must include in any modified copies of the +software prominent notices stating that you have modified the software. + +## No Other Rights + +These terms do not imply any licenses other than those expressly granted in +these terms. + +## Termination + +If you use the software in violation of these terms, such use is not licensed, +and your licenses will automatically terminate. If the licensor provides you +with a notice of your violation, and you cease all violation of this license no +later than 30 days after you receive that notice, your licenses will be +reinstated retroactively. However, if you violate these terms after such +reinstatement, any additional violation of these terms will cause your licenses +to terminate automatically and permanently. + +## No Liability + +*As far as the law allows, the software comes as is, without any warranty or +condition, and the licensor will not be liable to you for any damages arising +out of these terms or the use or nature of the software, under any kind of +legal claim.* + +## Definitions + +The **licensor** is the entity offering these terms, and the **software** is the +software the licensor makes available under these terms, including any portion +of it. + +**you** refers to the individual or entity agreeing to these terms. + +**your company** is any legal entity, sole proprietorship, or other kind of +organization that you work for, plus all organizations that have control over, +are under the control of, or are under common control with that +organization. **control** means ownership of substantially all the assets of an +entity, or the power to direct its management and policies by vote, contract, or +otherwise. Control can be direct or indirect. + +**your licenses** are all the licenses granted to you for the software under +these terms. + +**use** means anything you do with the software requiring one of your licenses. + +**trademark** means trademarks, service marks, and similar rights. diff --git a/packages/nginx_input_otel/_dev/build/docs/README.md b/packages/nginx_input_otel/_dev/build/docs/README.md new file mode 100644 index 00000000000..b61b790dd0f --- /dev/null +++ b/packages/nginx_input_otel/_dev/build/docs/README.md @@ -0,0 +1,63 @@ +# NGINX OpenTelemetry Input Package + +## Overview +The NGINX OpenTelemetry Input Package integration for Elastic enables collection of telemetry data from NGINX web servers through OpenTelemetry protocols using the [nginxreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/nginxreceiver#nginx-receiver). + +This integration facilitates comprehensive monitoring of NGINX web server performance, request processing, error tracking, and operational metrics to provide insights into web application infrastructure health and performance. + +### Compatibility + This Integration uses the upstream [nginxreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/nginxreceiver#nginx-receiver) to collect the metrics. + +### How it works +This integration receives telemetry data from NGINX servers by configuring the NGINX endpoint in the integration, which then gets applied to the nginxreceiver present in the EDOT collector, which then forwards the data to Elastic Agent. The Elastic Agent processes and enriches the data before sending it to Elasticsearch for indexing and analysis. Once the data arrives into Elasticsearch, its corresponding [NGINX OpenTelemetry Assets Package](https://www.elastic.co/docs/reference/integrations/nginx_otel) gets auto installed and the dashboards light up. + +## What data does this integration collect? +The NGINX OpenTelemetry Input Package integration collects telemetry data of the following types: + +* **Metrics** - Performance metrics including request rates, response times, connection counts, and server status + + +## What do I need to use this integration? +1. Permissions required: The collector requires access to the NGINX `stub_status` endpoint (for example, http://localhost:80/nginx_status). When running the collector, make sure you have the appropriate permissions to access this endpoint. + +2. NGINX configuration: The NGINX `stub_status` module must be enabled, and the status endpoint must be accessible. For example: +``` +server { + listen 80; + server_name localhost; + location /nginx_status { + stub_status on; + allow 127.0.0.1; + deny all; + } +} +``` +3. The NGINX endpoint configured in the Integration configuration from the UI. + + +## Metrics reference + +### NGINX metrics +The [NGINX receiver]((https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/nginxreceiver/documentation.md)) collects performance metrics from the NGINX `stub_status` module. Key metrics include: + + +| Metric Name | Description | Type | Attributes | +|-------------|-------------|------|------------| +| `nginx.requests` | Total number of client requests | Counter | - | +| `nginx.connections_accepted` | Total number of accepted client connections | Counter | - | +| `nginx.connections_handled` | Total number of handled connections | Counter | - | +| `nginx.connections_current` | Current number of client connections by state | Gauge | `state`: `active`, `reading`, `writing`, `waiting` | + +#### Connection States + +- `active`: Currently active client connections +- `reading`: Connections currently reading request headers +- `writing`: Connections currently writing response to client +- `waiting`: Idle client connections waiting for a request + +These metrics provide insights into: +- **Request volume and patterns** through request counts +- **Connection health** via accepted, and handled connection statistics +- **Server performance** using active, reading, writing, and waiting connection states + +For a complete list of all available metrics and their detailed descriptions, refer to the [NGINX Receiver documentation](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/nginxreceiver/documentation.md) in the upstream OpenTelemetry Collector repository. \ No newline at end of file diff --git a/packages/nginx_input_otel/agent/input/input.yml.hbs b/packages/nginx_input_otel/agent/input/input.yml.hbs new file mode 100644 index 00000000000..1187e1664d2 --- /dev/null +++ b/packages/nginx_input_otel/agent/input/input.yml.hbs @@ -0,0 +1,12 @@ +receivers: + nginx: + endpoint: {{nginx_endpoint}} + collection_interval: {{period}} +processors: + resourcedetection: + detectors: ["system", "ec2"] +service: + pipelines: + metrics: + receivers: [nginx] + processors: [resourcedetection] diff --git a/packages/nginx_input_otel/changelog.yml b/packages/nginx_input_otel/changelog.yml new file mode 100644 index 00000000000..f8ff66f6ab5 --- /dev/null +++ b/packages/nginx_input_otel/changelog.yml @@ -0,0 +1,6 @@ +# newer versions go on top +- version: "0.1.0" + changes: + - description: Initial draft of the package + type: enhancement + link: https://github.com/elastic/integrations/pull/15651 diff --git a/packages/nginx_input_otel/docs/README.md b/packages/nginx_input_otel/docs/README.md new file mode 100644 index 00000000000..b61b790dd0f --- /dev/null +++ b/packages/nginx_input_otel/docs/README.md @@ -0,0 +1,63 @@ +# NGINX OpenTelemetry Input Package + +## Overview +The NGINX OpenTelemetry Input Package integration for Elastic enables collection of telemetry data from NGINX web servers through OpenTelemetry protocols using the [nginxreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/nginxreceiver#nginx-receiver). + +This integration facilitates comprehensive monitoring of NGINX web server performance, request processing, error tracking, and operational metrics to provide insights into web application infrastructure health and performance. + +### Compatibility + This Integration uses the upstream [nginxreceiver](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/nginxreceiver#nginx-receiver) to collect the metrics. + +### How it works +This integration receives telemetry data from NGINX servers by configuring the NGINX endpoint in the integration, which then gets applied to the nginxreceiver present in the EDOT collector, which then forwards the data to Elastic Agent. The Elastic Agent processes and enriches the data before sending it to Elasticsearch for indexing and analysis. Once the data arrives into Elasticsearch, its corresponding [NGINX OpenTelemetry Assets Package](https://www.elastic.co/docs/reference/integrations/nginx_otel) gets auto installed and the dashboards light up. + +## What data does this integration collect? +The NGINX OpenTelemetry Input Package integration collects telemetry data of the following types: + +* **Metrics** - Performance metrics including request rates, response times, connection counts, and server status + + +## What do I need to use this integration? +1. Permissions required: The collector requires access to the NGINX `stub_status` endpoint (for example, http://localhost:80/nginx_status). When running the collector, make sure you have the appropriate permissions to access this endpoint. + +2. NGINX configuration: The NGINX `stub_status` module must be enabled, and the status endpoint must be accessible. For example: +``` +server { + listen 80; + server_name localhost; + location /nginx_status { + stub_status on; + allow 127.0.0.1; + deny all; + } +} +``` +3. The NGINX endpoint configured in the Integration configuration from the UI. + + +## Metrics reference + +### NGINX metrics +The [NGINX receiver]((https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/nginxreceiver/documentation.md)) collects performance metrics from the NGINX `stub_status` module. Key metrics include: + + +| Metric Name | Description | Type | Attributes | +|-------------|-------------|------|------------| +| `nginx.requests` | Total number of client requests | Counter | - | +| `nginx.connections_accepted` | Total number of accepted client connections | Counter | - | +| `nginx.connections_handled` | Total number of handled connections | Counter | - | +| `nginx.connections_current` | Current number of client connections by state | Gauge | `state`: `active`, `reading`, `writing`, `waiting` | + +#### Connection States + +- `active`: Currently active client connections +- `reading`: Connections currently reading request headers +- `writing`: Connections currently writing response to client +- `waiting`: Idle client connections waiting for a request + +These metrics provide insights into: +- **Request volume and patterns** through request counts +- **Connection health** via accepted, and handled connection statistics +- **Server performance** using active, reading, writing, and waiting connection states + +For a complete list of all available metrics and their detailed descriptions, refer to the [NGINX Receiver documentation](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/receiver/nginxreceiver/documentation.md) in the upstream OpenTelemetry Collector repository. \ No newline at end of file diff --git a/packages/nginx_input_otel/fields/base-fields.yml b/packages/nginx_input_otel/fields/base-fields.yml new file mode 100644 index 00000000000..7c798f4534c --- /dev/null +++ b/packages/nginx_input_otel/fields/base-fields.yml @@ -0,0 +1,12 @@ +- name: data_stream.type + type: constant_keyword + description: Data stream type. +- name: data_stream.dataset + type: constant_keyword + description: Data stream dataset. +- name: data_stream.namespace + type: constant_keyword + description: Data stream namespace. +- name: '@timestamp' + type: date + description: Event timestamp. diff --git a/packages/nginx_input_otel/img/nginx_otellogo.svg b/packages/nginx_input_otel/img/nginx_otellogo.svg new file mode 100644 index 00000000000..6f6443db28b --- /dev/null +++ b/packages/nginx_input_otel/img/nginx_otellogo.svg @@ -0,0 +1,17 @@ + + + + + + + + + + + + + + + + + diff --git a/packages/nginx_input_otel/img/sample-screenshot.png b/packages/nginx_input_otel/img/sample-screenshot.png new file mode 100644 index 00000000000..d7a56a3ecc0 Binary files /dev/null and b/packages/nginx_input_otel/img/sample-screenshot.png differ diff --git a/packages/nginx_input_otel/manifest.yml b/packages/nginx_input_otel/manifest.yml new file mode 100644 index 00000000000..da28509a03d --- /dev/null +++ b/packages/nginx_input_otel/manifest.yml @@ -0,0 +1,56 @@ +format_version: 3.5.0 +name: nginx_otel_input +title: "NGINX OpenTelemetry Input Package" +version: 0.1.0 +source: + license: "Elastic-2.0" +description: "NGINX OpenTelemetry Input Package" +type: input +categories: + - web + - observability + - opentelemetry +conditions: + kibana: + version: "^9.2.0" + elastic: + subscription: "basic" +screenshots: + - src: /img/sample-screenshot.png + title: Sample screenshot + size: 600x600 + type: image/png +icons: + - src: /img/nginx_otellogo.svg + title: Sample logo + size: 32x32 + type: image/svg+xml +policy_templates: + - name: nginxreceiver + type: metrics + title: NGINX OpenTelemetry Input + description: Collect NGINX metrics using OpenTelemetry + input: otelcol + template_path: input.yml.hbs + vars: + - name: nginx_endpoint + type: text + title: NGINX Endpoint + description: The endpoint for NGINX status page to collect metrics + required: true + show_user: true + default: http://localhost:80/status + - name: period + type: text + title: Collection Interval + description: How often to collect metrics + default: 10s + - name: additional_detectors + type: text + title: Additional Resource Detectors + description: Comma-separated list of additional resource detectors to use + required: false + show_user: true +owner: + github: elastic/obs-infraobs-integrations + type: elastic