Getting Started with Sensu Go

Whether you're completely new to Sensu, or a long-time Sensu user looking to see what's new in Sensu Go — you've come to the right place.

Let's Go!

$ curl -LO https://sensu.io/dl/sensu-go-5.16.1-macos-amd64.tar.gz
$ tar -xzvf sensu-go-5.16.1-macos-amd64.tar.gz
$ sudo mv sensuctl /usr/local/bin/sensuctl
$ _

$ curl -LO https://s3-us-west-2.amazonaws.com/sensu.io/sensu-go/5.16.1/sensu-go_5.16.1_darwin_amd64.tar.gz
$ tar -xzvf sensu-go_5.16.1_darwin_amd64.tar.gz
$ mv sensuctl /usr/local/bin/sensuctl
$ _

C:\> Invoke-WebRequest -Uri https://s3-us-west-2.amazonaws.com/sensu.io/sensu-go/5.16.1/sensu-go_5.16.1_windows_amd64.zip  -OutFile sensu-go_5.16.1_windows_amd64.zip
C:\> tar -xzvf sensu-go_5.16.1_windows_amd64.zip
C:\> _

$ curl -LO https://sensu.io/dl/sensu-go-5.16.1-linux-amd64.tar.gz
$ tar -xzvf sensu-go-5.16.1-linux-amd64.tar.gz
$ sudo mv sensuctl /usr/local/bin/sensuctl
$ _

Getting started is easy

Get Sensu up and running in as little as 15 minutes. In fact, you may be able to take the first steps in under a minute! Don't believe us? Give the following quick start guide a try, and let us know if we can help!

1. Install Sensu Go

Deploy our official Docker container to get up and running in seconds. Follow these steps, then visit your Sensu Go dashboard at http://localhost:3000/.

Complete installation guide Sensu Go architecture Explore the Sensu Go API

$ docker network create sensu
$ docker volume create sensu-backend-data
$ docker run -d --rm --name sensu-backend \
  --network sensu -p 8080:8080 -p 3000:3000 \
  -v sensu-backend-data:/var/lib/sensu \
  sensu/sensu:5.16.1 sensu-backend start
11bbb27c3
$ docker run -d --rm --network sensu -p :3030 \
  sensu/sensu:5.16.1 sensu-agent start \
  --backend-url ws://sensu-backend:8081 --deregister \
  --keepalive-interval=5 --keepalive-timeout=10 --subscriptions linux
$ curl -s http://localhost:8080/version
{"etcd":{"etcdserver":"3.3.13","etcdcluster":"3.3.0"},"sensu_backend":"5.16.1#b878b43"}
$ _

$ docker network create sensu
$ docker volume create sensu-backend-data
$ docker run -d --rm --name sensu-backend \
  --network sensu -p 8080:8080 -p 3000:3000 \
  -v sensu-backend-data:/var/lib/sensu \
  sensu/sensu:5.16.1 sensu-backend start
11bbb27c3
$ docker run -d --rm --network sensu -p :3030 \
  sensu/sensu:5.16.1 sensu-agent start \
  --backend-url ws://sensu-backend:8081 --deregister \
  --keepalive-interval=5 --keepalive-timeout=10 --subscriptions linux
$ curl -s http://localhost:8080/version
{"etcd":{"etcdserver":"3.3.13","etcdcluster":"3.3.0"},"sensu_backend":"5.16.1#b878b43"}
$ _

C:\> docker volume create sensu-backend-data
C:\> docker run -d --rm --name sensu-backend `
  -p 8080:8080 -p 3000:3000 `
  -v sensu-backend-data:/var/lib/sensu `
  sensu/sensu:5.16.1 sensu-backend start
C:\> docker run -d --rm --network sensu -p :3030 `
  sensu/sensu:5.16.1 sensu-agent start `
  --backend-url ws://sensu-backend:8081 --deregister `
  --keepalive-interval=5 --keepalive-timeout=10 --subscriptions linux
C:\> Invoke-RestMethod -Method Get -Uri http://localhost:8080/version
{"etcd":{"etcdserver":"3.3.13","etcdcluster":"3.3.0"},"sensu_backend":"5.16.1#b878b43"}
C:\> _

$ docker network create sensu
$ docker volume create sensu-backend-data
$ docker run -d --rm --name sensu-backend \
  --network sensu -p 8080:8080 -p 3000:3000 \
  -v sensu-backend-data:/var/lib/sensu \
  sensu/sensu:5.16.1 sensu-backend start
11bbb27c3
$ docker run -d --rm --network sensu -p :3030 \
  sensu/sensu:5.16.1 sensu-agent start \
  --backend-url ws://sensu-backend:8081 --deregister \
  --keepalive-interval=5 --keepalive-timeout=10 --subscriptions linux
$ curl -s http://localhost:8080/version
{"etcd":{"etcdserver":"3.3.13","etcdcluster":"3.3.0"},"sensu_backend":"5.16.1#b878b43"}
$ _

docker network create sensu
docker volume create sensu-backend-data
docker run -d --rm --name sensu-backend \
--network sensu -p 8080:8080 -p 3000:3000 \
-v sensu-backend-data:/var/lib/sensu \
sensu/sensu:5.16.1 sensu-backend start
docker run -d --rm --network sensu -p :3030 \
sensu/sensu:5.16.1 sensu-agent start \
--backend-url ws://sensu-backend:8081 --deregister \
--keepalive-interval=5 --keepalive-timeout=10 --subscriptions linux
curl -s http://localhost:8080/version

docker network create sensu
docker volume create sensu-backend-data
docker run -d --rm --name sensu-backend \
--network sensu -p 8080:8080 -p 3000:3000 \
-v sensu-backend-data:/var/lib/sensu \
sensu/sensu:5.16.1 sensu-backend start
docker run -d --rm --network sensu -p :3030 \
sensu/sensu:5.16.1 sensu-agent start \
--backend-url ws://sensu-backend:8081 --deregister \
--keepalive-interval=5 --keepalive-timeout=10 --subscriptions linux
curl -s http://localhost:8080/version

docker network create sensu
docker volume create sensu-backend-data
docker run -d --rm --name sensu-backend `
-p 8080:8080 -p 3000:3000 `
-v sensu-backend-data:/var/lib/sensu `
sensu/sensu:5.16.1 sensu-backend start
docker run -d --rm --network sensu -p :3030 `
sensu/sensu:5.16.1 sensu-agent start `
--backend-url ws://sensu-backend:8081 --deregister `
--keepalive-interval=5 --keepalive-timeout=10 --subscriptions linux

docker network create sensu
docker volume create sensu-backend-data
docker run -d --rm --name sensu-backend \
--network sensu -p 8080:8080 -p 3000:3000 \
-v sensu-backend-data:/var/lib/sensu \
sensu/sensu:5.16.1 sensu-backend start
docker run -d --rm --network sensu -p :3030 \
sensu/sensu:5.16.1 sensu-agent start \
--backend-url ws://sensu-backend:8081 --deregister \
--keepalive-interval=5 --keepalive-timeout=10 --subscriptions linux
curl -s http://localhost:8080/version

2. Install the Sensu Go CLI

Sensuctl is a command line interface for running commands against Sensu clusters. Install sensuctl on your laptop to gain access to your multi-cloud monitoring control plane.

Sensuctl for Windows, MacOS, more! Sensu CLI reference Sensu CLI quick start

$ curl -LO https://s3-us-west-2.amazonaws.com/sensu.io/sensu-go/5.16.1/sensu-go_5.16.1_linux_amd64.tar.gz
$ sudo tar -xzf sensu-go_5.16.1_linux_amd64.tar.gz -C /usr/local/bin/
$ sensuctl configure -n --url http://127.0.0.1:8080 \
  --username admin \
  --password "P@ssw0rd!" \
  --namespace default
$ sensuctl cluster health
ID                NAME     ERROR   HEALTHY
8927110dc66458af  default          true
$ sensuctl cluster id
sensu cluster id: "227b26eb-26c4-46b2-bc7c-8c080b072e6b"
$ _

$ curl -LO https://s3-us-west-2.amazonaws.com/sensu.io/sensu-go/5.16.1/sensu-go_5.16.1_darwin_amd64.tar.gz
$ tar -xzf sensu-go_5.16.1_darwin_amd64.tar.gz -C /usr/local/bin/
$ sensuctl configure -n --url http://127.0.0.1:8080 \
  --username admin \
  --password 'P@ssw0rd!' \
  --namespace default
$ sensuctl cluster health
ID                NAME     ERROR   HEALTHY
8927110dc66458af  default          true
$ sensuctl cluster id
sensu cluster id: "227b26eb-26c4-46b2-bc7c-8c080b072e6b"
$ _

C:\> Invoke-WebRequest -Uri https://s3-us-west-2.amazonaws.com/sensu.io/sensu-go/5.16.1/sensu-go_5.16.1_windows_amd64.zip  -OutFile sensu-go_5.16.1_windows_amd64.zip
C:\> Expand-Archive -LiteralPath sensu-go_5.16.1_windows_amd64.zip -DestinationPath .
C:\> ./sensuctl.exe configure -n --url http://127.0.0.1:8080 `
  --username admin `
  --password "P@ssw0rd!" `
  --namespace default
C:\> ./sensuctl.exe cluster health
ID                NAME     ERROR   HEALTHY
8927110dc66458af  default          true
C:\> ./sensuctl.exe cluster id
sensu cluster id: "227b26eb-26c4-46b2-bc7c-8c080b072e6b"
C:\> _

$ curl -LO https://s3-us-west-2.amazonaws.com/sensu.io/sensu-go/5.16.1/sensu-go_5.16.1_linux_amd64.tar.gz
$ sudo tar -xzf sensu-go_5.16.1_linux_amd64.tar.gz -C /usr/local/bin/
$ sensuctl configure -n --url http://127.0.0.1:8080 \
  --username admin \
  --password "P@ssw0rd!" \
  --namespace default
$ sensuctl cluster health
ID                NAME     ERROR   HEALTHY
8927110dc66458af  default          true
$ sensuctl cluster id
sensu cluster id: "227b26eb-26c4-46b2-bc7c-8c080b072e6b"
$ _

curl -LO https://s3-us-west-2.amazonaws.com/sensu.io/sensu-go/5.16.1/sensu-go_5.16.1_linux_amd64.tar.gz
sudo tar -xzf sensu-go_5.16.1_linux_amd64.tar.gz -C /usr/local/bin/
sensuctl configure -n --url http://127.0.0.1:8080 \
--username admin \
--password "P@ssw0rd!" \
--namespace default
sensuctl cluster health
sensuctl cluster id

curl -LO https://s3-us-west-2.amazonaws.com/sensu.io/sensu-go/5.16.1/sensu-go_5.16.1_darwin_amd64.tar.gz
tar -xzf sensu-go_5.16.1_darwin_amd64.tar.gz -C /usr/local/bin/
sensuctl configure -n --url http://127.0.0.1:8080 \
--username admin \
--password 'P@ssw0rd!' \
--namespace default
sensuctl cluster health
sensuctl cluster id

Invoke-WebRequest -Uri https://s3-us-west-2.amazonaws.com/sensu.io/sensu-go/5.16.1/sensu-go_5.16.1_windows_amd64.zip  -OutFile sensu-go_5.16.1_windows_amd64.zip
Expand-Archive -LiteralPath sensu-go_5.16.1_windows_amd64.zip -DestinationPath .
./sensuctl.exe configure -n --url http://127.0.0.1:8080 `
--username admin `
--password "P@ssw0rd!" `
--namespace default
./sensuctl.exe cluster health
./sensuctl.exe cluster id

curl -LO https://s3-us-west-2.amazonaws.com/sensu.io/sensu-go/5.16.1/sensu-go_5.16.1_linux_amd64.tar.gz
sudo tar -xzf sensu-go_5.16.1_linux_amd64.tar.gz -C /usr/local/bin/
sensuctl configure -n --url http://127.0.0.1:8080 \
--username admin \
--password "P@ssw0rd!" \
--namespace default
sensuctl cluster health
sensuctl cluster id

3. Configure your first monitor!

Sensu makes it easy to deploy instrumentation (e.g. plugins or scripts) and configure new monitors. This example shows how to monitor system clock drift.

Learn more about Sensu assets Learn more about Sensu checks Browse check plugins on Bonsai

$ sensuctl asset add sensu/monitoring-plugins:2.2.0-1
fetching bonsai asset: sensu/monitoring-plugins:2.2.0-1
added asset: sensu/monitoring-plugins:2.2.0-1
$ sensuctl check create ntp \
  --runtime-assets "sensu/monitoring-plugins" \
  --command "check_ntp_time -H time.nist.gov --warn 0.5 --critical 1.0" \
  --output-metric-format nagios_perfdata \
  --publish="true" --interval 30 --timeout 10 --subscriptions linux
$ sensuctl event list
ENTITY        CHECK      OUTPUT                                                                    STATUS  SILENCED   TIMESTAMP
a749e3a10d86  keepalive  Keepalive last sent from a749e3a10d86 at 2019-09-11 15:34:25 +0000 UTC    0       false      2019-09-11 08:34:25 -0700 PDT
a749e3a10d86  ntp        NTP OK: Offset -0.03375908732 secs|offset=-0.033759s;0.500000;1.000000;   0       false      2019-09-11 08:34:22 -0700 PDT
$ _

$ sensuctl asset add sensu/monitoring-plugins:2.2.0-1
fetching bonsai asset: sensu/monitoring-plugins:2.2.0-1
added asset: sensu/monitoring-plugins:2.2.0-1
$ sensuctl check create ntp \
  --runtime-assets "sensu/monitoring-plugins" \
  --command "check_ntp_time -H time.nist.gov --warn 0.5 --critical 1.0" \
  --output-metric-format nagios_perfdata \
  --publish="true" --interval 30 --timeout 10 --subscriptions linux
$ sensuctl event list
ENTITY        CHECK      OUTPUT                                                                    STATUS  SILENCED   TIMESTAMP
a749e3a10d86  keepalive  Keepalive last sent from a749e3a10d86 at 2019-09-11 15:34:25 +0000 UTC    0       false      2019-09-11 08:34:25 -0700 PDT
a749e3a10d86  ntp        NTP OK: Offset -0.03375908732 secs|offset=-0.033759s;0.500000;1.000000;   0       false      2019-09-11 08:34:22 -0700 PDT
$ _

C:\> ./sensuctl.exe asset add sensu/monitoring-plugins:2.2.0-1
fetching bonsai asset: sensu/monitoring-plugins:2.2.0-1
added asset: sensu/monitoring-plugins:2.2.0-1
C:\> ./sensuctl.exe check create ntp `
  --runtime-assets "sensu/monitoring-plugins" `
  --command "check_ntp_time -H time.nist.gov --warn 0.5 --critical 1.0" `
  --output-metric-format nagios_perfdata `
  --publish="true" --interval 30 --timeout 10 --subscriptions linux
C:\> ./sensuctl.exe event list
ENTITY        CHECK      OUTPUT                                                                    STATUS  SILENCED   TIMESTAMP
a749e3a10d86  keepalive  Keepalive last sent from a749e3a10d86 at 2019-09-11 15:34:25 +0000 UTC    0       false      2019-09-11 08:34:25 -0700 PDT
a749e3a10d86  ntp        NTP OK: Offset -0.03375908732 secs|offset=-0.033759s;0.500000;1.000000;   0       false      2019-09-11 08:34:22 -0700 PDT
C:\> _

$ sensuctl asset add sensu/monitoring-plugins:2.2.0-1
fetching bonsai asset: sensu/monitoring-plugins:2.2.0-1
added asset: sensu/monitoring-plugins:2.2.0-1
$ sensuctl check create ntp \
  --runtime-assets "sensu/monitoring-plugins" \
  --command "check_ntp_time -H time.nist.gov --warn 0.5 --critical 1.0" \
  --output-metric-format nagios_perfdata \
  --publish="true" --interval 30 --timeout 10 --subscriptions linux
$ sensuctl event list
ENTITY        CHECK      OUTPUT                                                                    STATUS  SILENCED   TIMESTAMP
a749e3a10d86  keepalive  Keepalive last sent from a749e3a10d86 at 2019-09-11 15:34:25 +0000 UTC    0       false      2019-09-11 08:34:25 -0700 PDT
a749e3a10d86  ntp        NTP OK: Offset -0.03375908732 secs|offset=-0.033759s;0.500000;1.000000;   0       false      2019-09-11 08:34:22 -0700 PDT
$ _

sensuctl asset add sensu/monitoring-plugins:2.2.0-1
sensuctl check create ntp \
--runtime-assets "sensu/monitoring-plugins" \
--command "check_ntp_time -H time.nist.gov --warn 0.5 --critical 1.0" \
--output-metric-format nagios_perfdata \
--publish="true" --interval 30 --timeout 10 --subscriptions linux
sensuctl event list

sensuctl asset add sensu/monitoring-plugins:2.2.0-1
sensuctl check create ntp \
--runtime-assets "sensu/monitoring-plugins" \
--command "check_ntp_time -H time.nist.gov --warn 0.5 --critical 1.0" \
--output-metric-format nagios_perfdata \
--publish="true" --interval 30 --timeout 10 --subscriptions linux
sensuctl event list

./sensuctl.exe asset add sensu/monitoring-plugins:2.2.0-1
./sensuctl.exe check create ntp `
--runtime-assets "sensu/monitoring-plugins" `
--command "check_ntp_time -H time.nist.gov --warn 0.5 --critical 1.0" `
--output-metric-format nagios_perfdata `
--publish="true" --interval 30 --timeout 10 --subscriptions linux
./sensuctl.exe event list

sensuctl asset add sensu/monitoring-plugins:2.2.0-1
sensuctl check create ntp \
--runtime-assets "sensu/monitoring-plugins" \
--command "check_ntp_time -H time.nist.gov --warn 0.5 --critical 1.0" \
--output-metric-format nagios_perfdata \
--publish="true" --interval 30 --timeout 10 --subscriptions linux
sensuctl event list

Congrats on getting up and running!

You're off to a great start! Wasn't that simple? Please take a moment to read some of the reference documentation that the guide has linked to – this should help explain what you've accomplished so far.

Are you ready for more? We'll continue to expand this page with additional examples – from configuring your first alert, to showing how to configure a simple automated remediation in Sensu, so check back soon. In the interim, why not go to the docs and try one of our guides?

Check Out the Guides

Join the community.

The Sensu Community communicates and collaborates on three main platforms.

GitHub

Access source code, share feedback, or report bugs related to the Sensu open source project on GitHub.

Browse GitHub

Discourse

Ask questions and get answers from Team Sensu, or other Sensu users on the Sensu Community Discourse.

Browse Discourse

Slack

Collaborate with other Sensu users in real time on the Sensu Community Slack workspace.

Join Slack

Register your Sensu install. Get rewarded!

Thanks for trying Sensu Go! Please take a moment to register your install so we can help you along your journey. We'll even reward you for reaching certain milestones. To get your first reward, simply add your first ten checks and connect at least ten agents and we'll send you your very own Sensu t-shirt.

Register