Skip to content

A ServiceNow distribution of the OpenTelemetry Collector

License

Notifications You must be signed in to change notification settings

lightstep/sn-collector

Repository files navigation

ServiceNow OpenTelemetry Collector (Experimental)

Action Status Action Test Status License

⚠️ Important: This is pre-release, experimental software under active development. There will be breaking changes between releases and it has not been tested on all platforms. Please contact your ServiceNow account team before installing to review eligibility. We recommend customers build their own collectors or use OpenTelemetry Collector Contrib for production software.

ServiceNow OpenTelemetry Collector is an experimental distribution of the OpenTelemetry Collector. It provides a unified way to receive, process, and export metric, trace, and log data for ServiceNow Cloud Observability and various services running on ServiceNow instances.

Feature Status Docs
Telemetry routing and processing ("gateway") 🟢 📘 Community docs
Kubernetes cluster and workload monitoring 🛠️ 📒 Install guide
Linux server monitoring 🟡 📒 Install guide
Windows server monitoring 🟡 📒 Install guide
macOS monitoring 🟡 📒 Install guide
Remote management (opAMP) 🛠️ 📒 Install guide
HTTP synthetic checks 🛠️ 📘 Community docs

Supported ServiceNow destinations

Native OTLP exporters can be used to send metrics, logs, and traces to ServiceNow Cloud Observability.

Destination Metrics Logs Traces Events
Cloud Observability OTLP OTLP OTLP OTLP (Logs)
ServiceNow MID Server Push API HLA REST API - Web Service API
ServiceNow Instance - - - Web Service API

Supported ServiceNow sources

Source Metrics Logs Traces Events
ServiceNow Instance - Log Export Service to OTLP Logs - -

ServiceNow Collector Built-in Components

The following tables represent the supported components of the ServiceNow Collector. Our goal is to upstream all in-house developed components (marked with *), where possible, to the -contrib distribution of the OpenTelemetry Collector.

Receivers

Receiver Status
otlp contrib
prometheus contrib
hostmetrics contrib
kafka contrib
k8sevents contrib
k8sobjects contrib
k8scluster contrib
kubeletstats contrib
lightstepreceiver under development
filelog contrib
httpcheck contrib
azuremonitor* contrib
azureeventhub contrib
osquery* contrib

Processors

Processor Status
k8sattributes contrib
resource contrib
resourcedetection contrib
transform contrib
concurrentbatch* under development

Exporters

Exporter Status
otlp in core
servicenow* under development
arrow* under development
debug in core
kafka contrib

Extensions

Extension Status
healthcheck contrib
opamp contrib

Connectors

Extension Status
countconnector in contrib

Getting help

We are providing support via GitHub on a best effort basis. ServiceNow customers should also open a case on https://support.servicenow.com/now.

Development and Contributing

Acknowledgements

  • Thank you to the many open-source distributions for OpenTelemetry collectors for providing patterns for deploying, building, and releasing this software. Where possible, we've tried to follow best practices and align with community standards and conventions.