Updating Smart Agent readme from main repo
@@ -11,6 +11,11 @@ source code along with more extensive documentation.
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
+agent](https://github.com/signalfx/collectd), but still uses that internally --
+so any existing Python or C-based collectd plugins will still work without
+modification.
+
The Smart Agent has three main components:
@@ -162,7 +167,7 @@ following commands:
```sh
curl -sSL https://dl.signalfx.com/debian.gpg > /etc/apt/trusted.gpg.d/signalfx.gpg
-echo 'deb https://dl.signalfx.com/debs/signalfx-agent/main /' > /etc/apt/sources.list.d/signalfx-agent.list
+echo 'deb https://dl.signalfx.com/debs/signalfx-agent/final /' > /etc/apt/sources.list.d/signalfx-agent.list
apt-get update
apt-get install -y signalfx-agent
```
@@ -175,7 +180,7 @@ following commands:
cat <<EOH > /etc/yum.repos.d/signalfx-agent.repo
[signalfx-agent]
name=SignalFx Agent Repository
-baseurl=https://dl.signalfx.com/rpms/signalfx-agent/main
+baseurl=https://dl.signalfx.com/rpms/signalfx-agent/final
gpgcheck=1
gpgkey=https://dl.signalfx.com/yum-rpm.key
enabled=1
@@ -283,6 +288,32 @@ but simply dumps its current status back upon connection. As a convenience,
the command `signalfx-agent status` will read this socket and dump out its
contents.
+The Smart Agent status output has the following sections:
+
+ - **Version**: The Smart Agent version and build time
+ - **Agent Configuration**: The current configuration in use by the Smart Agent, with
+ secret values replaced by `*`s. Default values will be shown here if they
+ were not set in the Smart Agent config file.
+ - **Writer Status**: The status and metrics about the writer component which
+ writes datapoints to SignalFx.
+ - **Observers**: The active observers in the Smart Agent
+ - **Monitor Configurations (Not necessarily active)**: A list of monitor
+ configurations that are in place. If a configuration has a discovery rule
+ but no discovered endpoints match that rule, there will not be any active
+ instances of this monitor.
+ - **Active Monitors**: Monitors instances that are actively monitoring
+ something. There may be multiple instances of these per configuration
+ above if there is a discovery rule that matches multiple services.
+ - **Discovered Endpoints**: A list of the endpoints discovered by the Smart Agent's
+ observers. The fields shown there will be the fields used when matching
+ discovery rules to a discovered endpoint.
+ - **Bad Monitor Configurations**: This will be a set of monitor configurations
+ that did not validate and the associated error. Bad monitor configuration
+ generally does not prevent the Smart Agent from starting up, but will prevent
+ that monitor from ever instantiating.
+
+Also see our [FAQ](https://github.com/signalfx/signalfx-agent/tree/master/docs/faq.md) for more troubleshooting help.
+
### DEVELOPMENT
If you wish to contribute to the Smart Agent, see the [Developer's
