Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions receiver/saphanareceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
<!-- status autogenerated section -->
# SAP HANA Receiver

<!-- status autogenerated section -->
This receiver can fetch stats from a SAP HANA instance. It leverages the [driver](https://github.com/SAP/go-hdb)
written by SAP for connecting to SAP HANA with the golang sql module to execute several monitoring queries.


| Status | |
| ------------- |-----------|
| Stability | [alpha]: metrics |
Expand All @@ -13,8 +17,6 @@
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->

This receiver can fetch stats from a SAP HANA instance. It leverages the [driver](https://github.com/SAP/go-hdb) written by SAP for connecting to SAP HANA with the golang sql module to execute several monitoring queries.

### Prerequisites

> The receiver is intended to support SAP HANA version 2, older versions have not been tested.
Expand Down
5 changes: 5 additions & 0 deletions receiver/saphanareceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
display_name: SAP HANA Receiver
type: saphana

description: |
This receiver can fetch stats from a SAP HANA instance. It leverages the [driver](https://github.com/SAP/go-hdb)
written by SAP for connecting to SAP HANA with the golang sql module to execute several monitoring queries.

status:
class: receiver
stability:
Expand Down
3 changes: 1 addition & 2 deletions receiver/signalfxreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# SignalFx Receiver

<!-- status autogenerated section -->
# SignalFx Receiver
| Status | |
| ------------- |-----------|
| Stability | [deprecated]: metrics, logs |
Expand Down
1 change: 1 addition & 0 deletions receiver/signalfxreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
display_name: SignalFx Receiver
type: signalfx

status:
Expand Down
8 changes: 5 additions & 3 deletions receiver/simpleprometheusreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
<!-- status autogenerated section -->
# Simple Prometheus Receiver

<!-- status autogenerated section -->
This receiver provides a simple configuration interface to configure the
prometheus receiver to scrape metrics from a single target.


| Status | |
| ------------- |-----------|
| Stability | [beta]: metrics |
Expand All @@ -15,8 +19,6 @@

The `prometheus_simple` receiver is a wrapper around the [prometheus
receiver](../prometheusreceiver).
This receiver provides a simple configuration interface to configure the
prometheus receiver to scrape metrics from a single target.

## Configuration

Expand Down
5 changes: 5 additions & 0 deletions receiver/simpleprometheusreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
display_name: Simple Prometheus Receiver
type: prometheus_simple

description: |
This receiver provides a simple configuration interface to configure the
prometheus receiver to scrape metrics from a single target.

status:
class: receiver
stability:
Expand Down
8 changes: 4 additions & 4 deletions receiver/skywalkingreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Skywalking Receiver

<!-- status autogenerated section -->
# SkyWalking Receiver

Receives trace data and metric data in [SkyWalking](https://skywalking.apache.org/) format.

| Status | |
| ------------- |-----------|
| Stability | [development]: metrics |
Expand All @@ -15,8 +17,6 @@
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->

Receives trace data and metric data in [Skywalking](https://skywalking.apache.org/) format.

Note: The current metrics receiver only supports receiving JVM data.

## Prerequisites
Expand Down
3 changes: 3 additions & 0 deletions receiver/skywalkingreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
display_name: SkyWalking Receiver
type: skywalking

description: Receives trace data and metric data in [SkyWalking](https://skywalking.apache.org/) format.

status:
class: receiver
stability:
Expand Down
13 changes: 7 additions & 6 deletions receiver/snmpreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# SNMP Receiver

<!-- status autogenerated section -->
# SNMP Receiver

This receiver fetches stats from an SNMP enabled host using a [golang
snmp client](https://github.com/gosnmp/gosnmp). Metrics are collected
based upon different configurations in the config file.


| Status | |
| ------------- |-----------|
| Stability | [alpha]: metrics |
Expand All @@ -14,10 +19,6 @@
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->

This receiver fetches stats from a SNMP enabled host using a [golang
snmp client](https://github.com/gosnmp/gosnmp). Metrics are collected
based upon different configurations in the config file.

## Purpose

The purpose of this receiver is to allow users to generically monitor metrics using SNMP.
Expand Down
6 changes: 6 additions & 0 deletions receiver/snmpreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
display_name: SNMP Receiver
type: snmp

description: |
This receiver fetches stats from an SNMP enabled host using a [golang
snmp client](https://github.com/gosnmp/gosnmp). Metrics are collected
based upon different configurations in the config file.

status:
class: receiver
stability:
Expand Down
8 changes: 5 additions & 3 deletions receiver/snowflakereceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Snowflake Receiver
<!-- status autogenerated section -->
# Snowflake Receiver

This receiver collects metrics from a Snowflake account by connecting to and querying a Snowflake deployment.


| Status | |
| ------------- |-----------|
| Stability | [alpha]: metrics |
Expand All @@ -12,8 +16,6 @@
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->

This receiver collects metrics from a Snowflake account by connecting to and querying a Snowflake deployment.

## Configuration

The following settings are required:
Expand Down
4 changes: 4 additions & 0 deletions receiver/snowflakereceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
display_name: Snowflake Receiver
type: snowflake

description: |
This receiver collects metrics from a Snowflake account by connecting to and querying a Snowflake deployment.

status:
class: receiver
stability:
Expand Down
7 changes: 4 additions & 3 deletions receiver/solacereceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
<!-- status autogenerated section -->
# Solace Receiver

<!-- status autogenerated section -->
The Solace Receiver receives trace data from a [Solace PubSub+ Event Broker](https://solace.com/products/event-broker/).


| Status | |
| ------------- |-----------|
| Stability | [beta]: traces |
Expand All @@ -13,8 +16,6 @@
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->

The Solace receiver receives trace data from a [Solace PubSub+ Event Broker](https://solace.com/products/event-broker/).

## Getting Started
To get started with the Solace receiver, a telemetry queue and authentication details must be configured. If connecting to a broker other than localhost, the `broker` field should be configured.
```yaml
Expand Down
4 changes: 4 additions & 0 deletions receiver/solacereceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
display_name: Solace Receiver
type: solace

description: |
The Solace Receiver receives trace data from a [Solace PubSub+ Event Broker](https://solace.com/products/event-broker/).

status:
class: receiver
stability:
Expand Down
15 changes: 8 additions & 7 deletions receiver/splunkenterprisereceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
<!-- status autogenerated section -->
# Splunk Enterprise Receiver

<!-- status autogenerated section -->
The Splunk Enterprise Receiver is a pull based tool which enables the ingestion of performance metrics describing the operational status of a user's Splunk Enterprise deployment to an appropriate observability tool.
It is designed to leverage several different data sources to gather these metrics including the [introspection api endpoint](https://help.splunk.com/en/splunk-enterprise/leverage-rest-apis/rest-api-reference/9.1/introspection-endpoints/introspection-endpoint-descriptions) and serializing
results from ad-hoc searches. Because of this, care must be taken by users when enabling metrics as running searches can effect your Splunk Enterprise Deployment and introspection may fail to report for Splunk
Cloud deployments. The primary purpose of this receiver is to empower those tasked with the maintenance and care of a Splunk Enterprise deployment to leverage opentelemetry and their observability toolset in their
jobs.


| Status | |
| ------------- |-----------|
| Stability | [alpha]: metrics |
Expand All @@ -13,12 +20,6 @@
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->

The Splunk Enterprise Receiver is a pull based tool which enables the ingestion of performance metrics describing the operational status of a user's Splunk Enterprise deployment to an appropriate observability tool.
It is designed to leverage several different data sources to gather these metrics including the [introspection api endpoint](https://help.splunk.com/en/splunk-enterprise/leverage-rest-apis/rest-api-reference/9.1/introspection-endpoints/introspection-endpoint-descriptions) and serializing
results from ad-hoc searches. Because of this, care must be taken by users when enabling metrics as running searches can effect your Splunk Enterprise Deployment and introspection may fail to report for Splunk
Cloud deployments. The primary purpose of this receiver is to empower those tasked with the maintenance and care of a Splunk Enterprise deployment to leverage opentelemetry and their observability toolset in their
jobs.

## Configuration

**By default the Splunk Enterprise receiver is not configured to gather any metrics other than `splunk.health`**
Expand Down
8 changes: 8 additions & 0 deletions receiver/splunkenterprisereceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
display_name: Splunk Enterprise Receiver
type: splunkenterprise

description: |
The Splunk Enterprise Receiver is a pull based tool which enables the ingestion of performance metrics describing the operational status of a user's Splunk Enterprise deployment to an appropriate observability tool.
It is designed to leverage several different data sources to gather these metrics including the [introspection api endpoint](https://help.splunk.com/en/splunk-enterprise/leverage-rest-apis/rest-api-reference/9.1/introspection-endpoints/introspection-endpoint-descriptions) and serializing
results from ad-hoc searches. Because of this, care must be taken by users when enabling metrics as running searches can effect your Splunk Enterprise Deployment and introspection may fail to report for Splunk
Cloud deployments. The primary purpose of this receiver is to empower those tasked with the maintenance and care of a Splunk Enterprise deployment to leverage opentelemetry and their observability toolset in their
jobs.

status:
class: receiver
stability:
Expand Down
17 changes: 9 additions & 8 deletions receiver/splunkhecreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
<!-- status autogenerated section -->
# Splunk HEC Receiver

<!-- status autogenerated section -->
The Splunk HEC receiver accepts events in the [Splunk HEC
format](https://help.splunk.com/en/splunk-enterprise/get-data-in/get-started-with-getting-data-in/10.0/get-data-with-http-event-collector/format-events-for-http-event-collector).
This allows the collector to receive logs and metrics.
The collector accepts data formatted as JSON [HEC events](https://help.splunk.com/en/splunk-enterprise/get-data-in/get-started-with-getting-data-in/10.0/get-data-with-http-event-collector/format-events-for-http-event-collector#ariaid-title5)
under any path or as EOL separated log [raw data](https://help.splunk.com/en/splunk-enterprise/get-data-in/get-started-with-getting-data-in/10.0/get-data-with-http-event-collector/format-events-for-http-event-collector#raw-event-parsing-0)
if sent to the `raw_path` path.


| Status | |
| ------------- |-----------|
| Stability | [beta]: metrics, logs |
Expand All @@ -13,13 +21,6 @@
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->

The Splunk HEC receiver accepts events in the [Splunk HEC
format](https://help.splunk.com/en/splunk-enterprise/get-data-in/get-started-with-getting-data-in/10.0/get-data-with-http-event-collector/format-events-for-http-event-collector).
This allows the collector to receive logs and metrics.
The collector accepts data formatted as JSON [HEC events](https://help.splunk.com/en/splunk-enterprise/get-data-in/get-started-with-getting-data-in/10.0/get-data-with-http-event-collector/format-events-for-http-event-collector#ariaid-title5)
under any path or as EOL separated log [raw data](https://help.splunk.com/en/splunk-enterprise/get-data-in/get-started-with-getting-data-in/10.0/get-data-with-http-event-collector/format-events-for-http-event-collector#raw-event-parsing-0)
if sent to the `raw_path` path.

## Configuration

The following settings are required:
Expand Down
9 changes: 9 additions & 0 deletions receiver/splunkhecreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
display_name: Splunk HEC Receiver
type: splunk_hec

description: |
The Splunk HEC receiver accepts events in the [Splunk HEC
format](https://help.splunk.com/en/splunk-enterprise/get-data-in/get-started-with-getting-data-in/10.0/get-data-with-http-event-collector/format-events-for-http-event-collector).
This allows the collector to receive logs and metrics.
The collector accepts data formatted as JSON [HEC events](https://help.splunk.com/en/splunk-enterprise/get-data-in/get-started-with-getting-data-in/10.0/get-data-with-http-event-collector/format-events-for-http-event-collector#ariaid-title5)
under any path or as EOL separated log [raw data](https://help.splunk.com/en/splunk-enterprise/get-data-in/get-started-with-getting-data-in/10.0/get-data-with-http-event-collector/format-events-for-http-event-collector#raw-event-parsing-0)
if sent to the `raw_path` path.

status:
class: receiver
stability:
Expand Down
7 changes: 4 additions & 3 deletions receiver/sqlqueryreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
<!-- status autogenerated section -->
# SQL Query Receiver

<!-- status autogenerated section -->
The SQL Query Receiver uses custom SQL queries to generate logs and/or metrics from a database connection.


| Status | |
| ------------- |-----------|
| Stability | [development]: logs |
Expand All @@ -16,8 +19,6 @@
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->

The SQL Query Receiver uses custom SQL queries to generate logs and/or metrics from a database connection.

> :construction: This receiver is in **ALPHA**. Behavior, configuration fields, and log or metric data model are subject to
> change.

Expand Down
4 changes: 4 additions & 0 deletions receiver/sqlqueryreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
display_name: SQL Query Receiver
type: sqlquery

description: |
The SQL Query Receiver uses custom SQL queries to generate logs and/or metrics from a database connection.

status:
class: receiver
stability:
Expand Down
11 changes: 6 additions & 5 deletions receiver/sqlserverreceiver/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
<!-- status autogenerated section -->
# Microsoft SQL Server Receiver

<!-- status autogenerated section -->
The `sqlserver` receiver grabs metrics/logs about a Microsoft SQL Server instance. The receiver works by either using the
Windows Performance Counters, or by directly connecting to the instance and querying it. Windows Performance Counters
are only available when running on Windows.


| Status | |
| ------------- |-----------|
| Stability | [development]: logs |
Expand All @@ -16,10 +21,6 @@
[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
<!-- end autogenerated section -->

The `sqlserver` receiver grabs metrics/logs about a Microsoft SQL Server instance. The receiver works by either using the
Windows Performance Counters, or by directly connecting to the instance and querying it. Windows Performance Counters
are only available when running on Windows.

## Required Permissions

### Windows Performance Counters
Expand Down
7 changes: 7 additions & 0 deletions receiver/sqlserverreceiver/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
display_name: Microsoft SQL Server Receiver
type: sqlserver

description: |
The `sqlserver` receiver grabs metrics/logs about a Microsoft SQL Server instance. The receiver works by either using the
Windows Performance Counters, or by directly connecting to the instance and querying it. Windows Performance Counters
are only available when running on Windows.


status:
class: receiver
stability:
Expand Down
Loading