Skip to content
This repository has been archived by the owner on Oct 23, 2024. It is now read-only.

SA deprecation notice for April 15 GA #1720

Merged
merged 14 commits into from
Apr 15, 2021
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
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
[![GoDoc](https://godoc.org/github.com/signalfx/signalfx-agent?status.svg)](https://godoc.org/github.com/signalfx/signalfx-agent)
[![CircleCI](https://circleci.com/gh/signalfx/signalfx-agent.svg?style=shield)](https://circleci.com/gh/signalfx/signalfx-agent)

:warning: **SignalFx Smart Agent is deprecated. For details, see the [Deprecation Notice](./docs/smartagent-deprecation-notice.md)** :warning:

The SignalFx Smart Agent is a metric agent written in Go for monitoring
infrastructure and application services in a variety of different environments.
It is meant as a successor to our previous [collectd
Expand Down Expand Up @@ -369,4 +371,3 @@ Also see our [FAQ](./docs/faq.md) for more troubleshooting help.

If you wish to contribute to the agent, see the [Developer's
Guide](./docs/development.md).

4 changes: 2 additions & 2 deletions docs/agent-install-awsecs.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Install to AWS ECS

:warning: **SignalFx Smart Agent is deprecated. For details, see the [Deprecation Notice](./smartagent-deprecation-notice.md)** :warning:

Deploy the SignalFx Smart Agent to an AWS ECS instance using a SignalFx
configuration script, and run the Smart Agent as a Daemon service in an
EC2 ECS cluster.
Expand Down Expand Up @@ -119,5 +121,3 @@ To create this service in the ECS web admin console:

* For APM monitoring, learn how to install, configure, and verify the Smart Agent for Microservices APM (**µAPM**). See
[Get started with SignalFx µAPM](https://docs.signalfx.com/en/latest/apm/apm-getting-started/apm-index.html).


5 changes: 3 additions & 2 deletions docs/agent-install-config-mgmt.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Install using configuration management

:warning: **SignalFx Smart Agent is deprecated. For details, see the [Deprecation Notice](./smartagent-deprecation-notice.md)** :warning:

Install the SignalFx Smart Agent using one of the following configuration management
packages:

Expand Down Expand Up @@ -314,7 +316,7 @@ Before you install, configure a Smart Agent Puppet manifest.

2. From the downloaded module, add the Smart Agent manifest to your Puppet installation.
3. Update your Puppet manifest with the `signalfx_agent` class and these parameters:

- `$config`: The Smart Agent configuration. Replace `<access_token>` and `<realm>` with the access token and realm
values you obtained in [Prerequisites for all platforms](#prerequisites-for-all-platforms).
All other properties are optional. For example, the following parameter represents a basic configuration that monitors
Expand Down Expand Up @@ -428,4 +430,3 @@ After you configure the Smart Agent Salt formula, Salt installs the Smart Agent
### Verify your Salt installation

See [Verify the Smart Agent](#verify-the-smart-agent).

2 changes: 2 additions & 0 deletions docs/agent-install-packages.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Install using *nix packages

:warning: **SignalFx Smart Agent is deprecated. For details, see the [Deprecation Notice](./smartagent-deprecation-notice.md)** :warning:

Install the SignalFx Smart Agent using either a Debian or RPM package,
and then verify that the SignalFx Smart Agent is working.

Expand Down
2 changes: 2 additions & 0 deletions docs/agent-install-standalone-linux.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Install to Linux using a tar.gz File

:warning: **SignalFx Smart Agent is deprecated. For details, see the [Deprecation Notice](./smartagent-deprecation-notice.md)** :warning:

Install the Smart Agent to Linux host using a compressed
`tar` file.

Expand Down
2 changes: 2 additions & 0 deletions docs/agent-install-standalone-windows.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Install to Windows using a ZIP file

:warning: **SignalFx Smart Agent is deprecated. For details, see the [Deprecation Notice](./smartagent-deprecation-notice.md)** :warning:

Install the SignalFx Smart Agent to a Windows host using a standalone package in
a ZIP file.

Expand Down
4 changes: 2 additions & 2 deletions docs/agent-k8s-install-helm.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Install Using Helm

:warning: **SignalFx Smart Agent is deprecated. For details, see the [Deprecation Notice](./smartagent-deprecation-notice.md)** :warning:

Use the Helm package manager to install the Smart Agent to Kubernetes
environments.

Expand Down Expand Up @@ -116,5 +118,3 @@ To verify that your installation and config is working:

* For APM monitoring, learn how to install, configure, and verify the Smart Agent for Microservices APM (**µAPM**). See
[Get started with SignalFx µAPM](https://docs.signalfx.com/en/latest/apm/apm-getting-started/apm-index.html).


2 changes: 2 additions & 0 deletions docs/agent-k8s-install-kubectl.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Install using kubectl

:warning: **SignalFx Smart Agent is deprecated. For details, see the [Deprecation Notice](./smartagent-deprecation-notice.md)** :warning:

Use kubectl to install the Smart Agent to Kubernetes environments.

If you have Helm installed already, you can also use Helm
Expand Down
2 changes: 1 addition & 1 deletion docs/monitors/prometheus-go.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Monitor Type: `prometheus/go` ([Source](https://github.com/signalfx/signalfx-age

## Overview

This monitor scrapes [Prmoetheus Go
This monitor scrapes [Prometheus Go
collector](https://godoc.org/github.com/prometheus/client_golang/prometheus#NewGoCollector)
and [Prometheus process
collector](https://godoc.org/github.com/prometheus/client_golang/prometheus#NewProcessCollector)
Expand Down
2 changes: 1 addition & 1 deletion docs/monitors/prometheus-nginx-vts.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Monitor Type: `prometheus/nginx-vts` ([Source](https://github.com/signalfx/signa

## Overview

This monitor scrapes [Prmoetheus Nginx VTS
This monitor scrapes [Prometheus Nginx VTS
exporter](https://github.com/hnlq715/nginx-vts-exporter) metrics from a
Prometheus exporter and sends them to SignalFx. It is a wrapper around the
[prometheus-exporter](./prometheus-exporter.md) monitor that provides a
Expand Down
2 changes: 1 addition & 1 deletion docs/monitors/prometheus-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Monitor Type: `prometheus/node` ([Source](https://github.com/signalfx/signalfx-a

## Overview

This monitor scrapes [Prmoetheus Node
This monitor scrapes [Prometheus Node
Exporter](https://github.com/prometheus/node_exporter) metrics and sends
them to SignalFx. It is a wrapper around the
[prometheus-exporter](./prometheus-exporter.md) monitor that provides a
Expand Down
2 changes: 1 addition & 1 deletion docs/monitors/prometheus-postgres.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Monitor Type: `prometheus/postgres` ([Source](https://github.com/signalfx/signal

## Overview

This monitor scrapes [Prmoetheus PostgreSQL Server
This monitor scrapes [Prometheus PostgreSQL Server
Exporter](https://github.com/wrouesnel/postgres_exporter) metrics and sends
them to SignalFx. It is a wrapper around the
[prometheus-exporter](./prometheus-exporter.md) monitor that provides a
Expand Down
2 changes: 1 addition & 1 deletion docs/monitors/prometheus-prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Monitor Type: `prometheus/prometheus` ([Source](https://github.com/signalfx/sign

## Overview

This monitor scrapes [Prmoetheus server's own internal
This monitor scrapes [Prometheus server's own internal
collector](https://prometheus.io/docs/prometheus/latest/getting_started/#configuring-prometheus-to-monitor-itself)
metrics from a Prometheus exporter and sends them to SignalFx. It is a
wrapper around the [prometheus-exporter](./prometheus-exporter.md) monitor
Expand Down
2 changes: 1 addition & 1 deletion docs/monitors/prometheus-redis.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Monitor Type: `prometheus/redis` ([Source](https://github.com/signalfx/signalfx-

## Overview

This monitor scrapes [Prmoetheus Redis
This monitor scrapes [Prometheus Redis
Exporter](https://github.com/oliver006/redis_exporter) metrics and sends
them to SignalFx. It is a wrapper around the
[prometheus-exporter](./prometheus-exporter.md) monitor that provides a
Expand Down
7 changes: 3 additions & 4 deletions docs/quick-install.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
<!--- OVERVIEW --->
# Quick Install

This integration installs the SignalFx Smart Agent application on a
single host machine from which you want to collect monitoring data.
Use this integration if you want to evaluate monitoring on a single host.
The Smart Agent collects infrastructure monitoring, APM, and Kubernetes data.
SignalFx Smart Agent is deprecated. For details, see the [Deprecation Notice](./smartagent-deprecation-notice.md).

SignalFx Smart Agent Integration installs the Smart Agent application on a single host machine from which you want to collect monitoring data. Smart Agent collects infrastructure monitoring, µAPM, and Kubernetes data.

For other installation options, including bulk deployments to production,
see [Install and Configure the Smart Agent](https://docs.signalfx.com/en/latest/integrations/agent/agent-install-methods.html).
Expand Down
7 changes: 7 additions & 0 deletions docs/smartagent-deprecation-notice.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Deprecation Notice for SignalFx Smart Agent

Smart Agent is deprecated as part of the release of Splunk Observability Cloud:

* Smart Agent continues to function and is still supported by Splunk.
* Apart from the [documented exceptions](https://docs.splunk.com/Observability/get-started/migrate/migrate-to-otel.html) where integration with Splunk Observability Cloud still requires deploying Smart Agent, Smart Agent functionality is replaced by the [Splunk Distribution of OpenTelemetry Connector](https://docs.splunk.com/Observability/get-started/get-data-in/get-data-in.html).
* Splunk is committed to further development of OpenTelemetry, and may discontinue support for Smart Agent in the future after providing customers advance notice of such discontinuation.
2 changes: 1 addition & 1 deletion pkg/monitors/prometheus/go/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ goPackage: prometheusgo
monitors:
- monitorType: prometheus/go
doc: |
This monitor scrapes [Prmoetheus Go
This monitor scrapes [Prometheus Go
collector](https://godoc.org/github.com/prometheus/client_golang/prometheus#NewGoCollector)
and [Prometheus process
collector](https://godoc.org/github.com/prometheus/client_golang/prometheus#NewProcessCollector)
Expand Down
2 changes: 1 addition & 1 deletion pkg/monitors/prometheus/nginxvts/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
monitors:
- monitorType: prometheus/nginx-vts
doc: |
This monitor scrapes [Prmoetheus Nginx VTS
This monitor scrapes [Prometheus Nginx VTS
exporter](https://github.com/hnlq715/nginx-vts-exporter) metrics from a
Prometheus exporter and sends them to SignalFx. It is a wrapper around the
[prometheus-exporter](./prometheus-exporter.md) monitor that provides a
Expand Down
2 changes: 1 addition & 1 deletion pkg/monitors/prometheus/node/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
monitors:
- monitorType: prometheus/node
doc: |
This monitor scrapes [Prmoetheus Node
This monitor scrapes [Prometheus Node
Exporter](https://github.com/prometheus/node_exporter) metrics and sends
them to SignalFx. It is a wrapper around the
[prometheus-exporter](./prometheus-exporter.md) monitor that provides a
Expand Down
2 changes: 1 addition & 1 deletion pkg/monitors/prometheus/postgres/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
monitors:
- monitorType: prometheus/postgres
doc: |
This monitor scrapes [Prmoetheus PostgreSQL Server
This monitor scrapes [Prometheus PostgreSQL Server
Exporter](https://github.com/wrouesnel/postgres_exporter) metrics and sends
them to SignalFx. It is a wrapper around the
[prometheus-exporter](./prometheus-exporter.md) monitor that provides a
Expand Down
2 changes: 1 addition & 1 deletion pkg/monitors/prometheus/prometheus/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
monitors:
- monitorType: prometheus/prometheus
doc: |
This monitor scrapes [Prmoetheus server's own internal
This monitor scrapes [Prometheus server's own internal
collector](https://prometheus.io/docs/prometheus/latest/getting_started/#configuring-prometheus-to-monitor-itself)
metrics from a Prometheus exporter and sends them to SignalFx. It is a
wrapper around the [prometheus-exporter](./prometheus-exporter.md) monitor
Expand Down
2 changes: 1 addition & 1 deletion pkg/monitors/prometheus/redis/metadata.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
monitors:
- monitorType: prometheus/redis
doc: |
This monitor scrapes [Prmoetheus Redis
This monitor scrapes [Prometheus Redis
Exporter](https://github.com/oliver006/redis_exporter) metrics and sends
them to SignalFx. It is a wrapper around the
[prometheus-exporter](./prometheus-exporter.md) monitor that provides a
Expand Down
9 changes: 3 additions & 6 deletions scripts/docs/templates/integrations_doc.md.jinja2
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ configuration instructions below.

## Description

**This integration primarily consists of the Smart Agent monitor{% if has_multiple_monitors %}s{% endif %} {{ integration.monitor_types|surround_by_tick|join(', ') }}.
Below is an overview of {% if has_multiple_monitors %}the monitors{% else %}that monitor{% endif %}.**
This integration primarily consists of the Smart Agent monitor{% if has_multiple_monitors %}s{% endif %} {{ integration.monitor_types|surround_by_tick|join(', ') }}.
Below is an overview of {% if has_multiple_monitors %}the monitors{% else %}that monitor{% endif %}.

### Smart Agent Monitor{% if has_multiple_monitors %}s{% endif %}

Expand Down Expand Up @@ -115,7 +115,7 @@ monitors` after configuring this monitor in a running agent instance.

### Legacy non-default metrics (version < 4.7.0)

**The following information only applies to agent version older than 4.7.0. If
**The following information only applies to agent versions prior to 4.7.0. If
you have a newer agent and have set `enableBuiltInFiltering: true` at the top
level of your agent config, see the section above. See upgrade instructions in
[Old-style inclusion list filtering](../legacy-filtering.md#old-style-inclusion-list-filtering).**
Expand Down Expand Up @@ -174,6 +174,3 @@ are set on the dimension values of the dimension specified.
{%- endif -%}
{%- endfor %}
{%- endif -%}



12 changes: 6 additions & 6 deletions selfdescribe.json
Original file line number Diff line number Diff line change
Expand Up @@ -44066,7 +44066,7 @@
"sendUnknown": false,
"noneIncluded": false,
"dimensions": null,
"doc": "This monitor scrapes [Prmoetheus Go\ncollector](https://godoc.org/github.com/prometheus/client_golang/prometheus#NewGoCollector)\nand [Prometheus process\ncollector](https://godoc.org/github.com/prometheus/client_golang/prometheus#NewProcessCollector)\nmetrics from a Prometheus exporter and sends them to SignalFx. It is a\nwrapper around the [prometheus-exporter](./prometheus-exporter.md) monitor\nthat provides a restricted but expandable set of metrics.\n",
"doc": "This monitor scrapes [Prometheus Go\ncollector](https://godoc.org/github.com/prometheus/client_golang/prometheus#NewGoCollector)\nand [Prometheus process\ncollector](https://godoc.org/github.com/prometheus/client_golang/prometheus#NewProcessCollector)\nmetrics from a Prometheus exporter and sends them to SignalFx. It is a\nwrapper around the [prometheus-exporter](./prometheus-exporter.md) monitor\nthat provides a restricted but expandable set of metrics.\n",
"groups": {
"": {
"description": "",
Expand Down Expand Up @@ -44659,7 +44659,7 @@
"sendUnknown": false,
"noneIncluded": false,
"dimensions": null,
"doc": "This monitor scrapes [Prmoetheus Nginx VTS\nexporter](https://github.com/hnlq715/nginx-vts-exporter) metrics from a\nPrometheus exporter and sends them to SignalFx. It is a wrapper around the\n[prometheus-exporter](./prometheus-exporter.md) monitor that provides a\nrestricted but expandable set of metrics.\n",
"doc": "This monitor scrapes [Prometheus Nginx VTS\nexporter](https://github.com/hnlq715/nginx-vts-exporter) metrics from a\nPrometheus exporter and sends them to SignalFx. It is a wrapper around the\n[prometheus-exporter](./prometheus-exporter.md) monitor that provides a\nrestricted but expandable set of metrics.\n",
"groups": {
"": {
"description": "",
Expand Down Expand Up @@ -44924,7 +44924,7 @@
"sendUnknown": false,
"noneIncluded": false,
"dimensions": null,
"doc": "This monitor scrapes [Prmoetheus Node\nExporter](https://github.com/prometheus/node_exporter) metrics and sends\nthem to SignalFx. It is a wrapper around the\n[prometheus-exporter](./prometheus-exporter.md) monitor that provides a\nrestricted but expandable set of metrics.\n",
"doc": "This monitor scrapes [Prometheus Node\nExporter](https://github.com/prometheus/node_exporter) metrics and sends\nthem to SignalFx. It is a wrapper around the\n[prometheus-exporter](./prometheus-exporter.md) monitor that provides a\nrestricted but expandable set of metrics.\n",
"groups": {
"": {
"description": "",
Expand Down Expand Up @@ -46169,7 +46169,7 @@
"sendUnknown": false,
"noneIncluded": false,
"dimensions": null,
"doc": "This monitor scrapes [Prmoetheus PostgreSQL Server\nExporter](https://github.com/wrouesnel/postgres_exporter) metrics and sends\nthem to SignalFx. It is a wrapper around the\n[prometheus-exporter](./prometheus-exporter.md) monitor that provides a\nrestricted but expandable set of metrics.\n",
"doc": "This monitor scrapes [Prometheus PostgreSQL Server\nExporter](https://github.com/wrouesnel/postgres_exporter) metrics and sends\nthem to SignalFx. It is a wrapper around the\n[prometheus-exporter](./prometheus-exporter.md) monitor that provides a\nrestricted but expandable set of metrics.\n",
"groups": {
"": {
"description": "",
Expand Down Expand Up @@ -47995,7 +47995,7 @@
"sendUnknown": false,
"noneIncluded": false,
"dimensions": null,
"doc": "This monitor scrapes [Prmoetheus server's own internal\ncollector](https://prometheus.io/docs/prometheus/latest/getting_started/#configuring-prometheus-to-monitor-itself)\nmetrics from a Prometheus exporter and sends them to SignalFx. It is a\nwrapper around the [prometheus-exporter](./prometheus-exporter.md) monitor\nthat provides a restricted but expandable set of metrics.\n",
"doc": "This monitor scrapes [Prometheus server's own internal\ncollector](https://prometheus.io/docs/prometheus/latest/getting_started/#configuring-prometheus-to-monitor-itself)\nmetrics from a Prometheus exporter and sends them to SignalFx. It is a\nwrapper around the [prometheus-exporter](./prometheus-exporter.md) monitor\nthat provides a restricted but expandable set of metrics.\n",
"groups": {
"": {
"description": "",
Expand Down Expand Up @@ -49128,7 +49128,7 @@
"sendUnknown": false,
"noneIncluded": false,
"dimensions": null,
"doc": "This monitor scrapes [Prmoetheus Redis\nExporter](https://github.com/oliver006/redis_exporter) metrics and sends\nthem to SignalFx. It is a wrapper around the\n[prometheus-exporter](./prometheus-exporter.md) monitor that provides a\nrestricted but expandable set of metrics.\n",
"doc": "This monitor scrapes [Prometheus Redis\nExporter](https://github.com/oliver006/redis_exporter) metrics and sends\nthem to SignalFx. It is a wrapper around the\n[prometheus-exporter](./prometheus-exporter.md) monitor that provides a\nrestricted but expandable set of metrics.\n",
"groups": {
"": {
"description": "",
Expand Down