sensu-go

[Under Construction] Chef Cookbook for The Sensu Go project

Community

Sensu is discussed in many places but typically the best place to get adhoc general help is through or community slack in #chef channel.

Scope

This Chef Cookbook is for installing & configuring Sensu 5.x
See the sensu cookbook if you wish to manage Sensu 1.x via Chef.

Requirements

• Chef 12.5 or higher.
• Network accessible package repositories.

Platform Support

The following platforms have been tested with Test Kitchen. It will most likely work on other platforms as well.

Cookbook Dependencies

• packagecloud

Usage

This is a library style cookbook that provides a set of resources to install and configure the Sensu 5.x environment in a composable way. It is intended to be used in your own wrapper cookbook suited to your specific needs. You can see a very simple example usage in the default recipe of the sensu_test cookbook that is included in this repo. This recipe is used as part of integration testing.

• add depends 'sensu-go' to the metadata.rb for your cookbook.
• use the provided resources in your cookbook

sensu_backend 'default' do
  action [:install, :init]
end

sensu_agent 'default'

sensu_ctl 'default' do
  action [:install, :configure]
end

sensu_check 'cron' do
  command '/bin/true'
  cron '@hourly'
  subscriptions %w(dad_jokes production)
  handlers %w(pagerduty email)
  annotations(runbook: 'https://www.xkcd.com/378/')
  publish false
  ttl 100
  high_flap_threshold 60
  low_flap_threshold 20
  action :create
end

# data bag contains url, checksum for asssets
assets = data_bag_item('sensu', 'assets')
assets.each do |name, property|
  next if name == 'id'
  sensu_asset name do
    url property['url']
    sha512 property['checksum']
  end
end

sensu_handler 'slack' do
  type 'pipe'
  command 'handler-slack --webhook-url https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX --channel monitoring'
end

sensu_filter 'production_filter' do
  filter_action 'allow'
  expressions [
    "event.Entity.Environment == 'production'",
  ]
end

sensu_mutator 'example-mutator' do
  command 'example_mutator.rb'
  timeout 60
end

Testing

For more details look at the [TESTING.md](./TESTING.md).

Resource Overview

These resources primarily work by writing the Sensu 5.x object definitions to a local path and then using the sensuctl command line to reconfigure the definitions known to the sensu backend.

• sensu_backend: Install and configure the Sensu backend
• sensu_agent: Install and configure the Sensu agent
• sensu_ctl: Install and configure the sensuctl
• sensu_check: Configure Sensu checks
• sensu_handler: Configure check handlers
• sensu_hook: Configure Sensu hooks for use with checks
• sensu_filter: Configure Sensu filters
• sensu_mutator: Configure Sensu mutators
• sensu_asset: Configure Sensu assets for use with checks
• sensu_namespace: Configure Sensu namespaces
• sensu_entity: Configure Sensu entities
• sensu_role: Configure Sensu RBAC roles
• sensu_role_binding: Configure Sensu RBAC role bindings
• sensu_cluster_role: Configure Sensu RBAC cluster roles
• sensu_cluster_role_binding: Configure Sensu RBAC cluster role bindings
• sensu_postgres_config: Configure Sensu to use a Postgres DB for event storage
• sensu_active_directory: Configure Sensu to use Active Directory authentication
• sensu_secret: Configure Sensu secrets
• sensu_secrets_provider: Configure Sensu secrets providers

Resource Details

Common properties

Sensu resources that support metadata attributes share these common properties:

• namespace the Sensu RBAC namespace that this check belongs to, default: default
• labels custom extended attributes to add to the check
• annotations custom extended attributes to add to the check

name metadata will be set automatically from the resource name

sensu_backend

The sensu backend resource can configure the core sensu backend service.

Properties

• version which version to install, default: latest
• repo which repo to pull package from, default: sensu/stable. If using private yum or apt repository, this is the baseurl/uri.
• config_home where to store the generated object definitions, default: /etc/sensu
• config a hash of configuration, default: { 'state-dir': '/var/lib/sensu/sensu-backend'}
• distribution possible values: commercial, source. Requires a valid yum or apt repository for installation. default: commercial
• gpgkey To be used with a package built from source. The GPG key for the package.
• username the username to initialize the backend with
• password the password to initialize the backend with

Examples

sensu_backend 'default'

For using packages built from source:

sensu_backend 'default' do
distribution 'source'
repo 'https://my-custom-repo.com/yum/$releasever/$basearch/'
end

Optionally pass configuration values for the backend:

(insecure example, don't really do this)
rb
sensu_backend 'default' do
repo 'sensu/stable'
config({'state-dir' => '/var/lib/sensu/sensu-backend',
'trusted-ca-file' => "/some/local/path.pem",
'insecure-skip-tls-verify' => true})
end


sensu_agent

The sensu agent resource will install and configure the agent. As of Sensu Go 6.0.0, it is no longer possible to update an existing agent configuration with this resource, and an agent entity should be made via sensu_entity.
NOTE: windows agent install is pinned to version 5.10 until available in a consumable package format (likely chocolately)

Properties

• version which version to install, default: latest
• repo which repo to pull package from, default: sensu/stable
• config_home where to store the generated object definitions, default: /etc/sensu
• config a hash of configuration

Examples

sensu_agent 'default'

(insecure example, don't really do this)

sensu_agent 'default' do
  config(
    "name": node['fqdn'],
    "namespace": "default",
    "backend-url": ["wss://sensu-backend.example.com:8081"],
    "insecure-skip-tls-verify": true,
    "subscriptions": ["centos", "haproxy"],
    "labels": {
      "app_id": "mycoolapp",
      "app_tier": "loadbalancer"
    },
    "annotations": {
      "color": "green"
    }
  )
end

sensu_ctl

Installs and configures the sensuctl cli

Properties

• version which version to install, default: latest
• repo which repo to pull package from, default: sensu/nightly
• username username for connecting to the sensu backend
• password password for connecting to the sensu backend
• backend_url url for the sensu backend, default: http://127.0.0.1:8080 #### Examples rb sensu_ctl 'default' rb sensu_ctl 'default' do backend_url 'https://sensu.startup.horse' end

sensu_check

The sensu_check resource is used to define check objects.

Properties

• config_home default: /etc/sensu
• check_hooks an array of hook name to run in response to the check
• command required the check command to execute
• cron a schedule for the check, in cron format or a predefined schedule
• handlers an array of handlers to run in response to the check, default: []
• high_flap_threshold The flap detection high threshold, in percent
• interval The frequency in seconds the check is executed.
• low_flap_threshold The flap detection low threshold, in percent
• namespace the Sensu RBAC namespace that this check belongs to, default: default
• proxy_entity_name Used to create a proxy entity for an external resource
• proxy_requests A Sensu Proxy Request, representing Sensu entity attributes to match entities in the registry.
• publish If check requests are published for the check
• round_robin If the check should be executed in a round robin fashion
• runtime_assets An array of Sensu assets required at runtime for the execution of the command
• secrets An array of hashes of name/secret pairs to use with command execution
• stdin If the Sensu agent writes JSON serialized entity and check data to the command process' STDIN
• subscriptions required an array of Sensu entity subscriptions that check requests will be sent to
• timeout The check execution duration timeout in seconds
• ttl The value in seconds until check results are considered stale
• output_metric_format (optional) the metric format that the output of this check conforms to
• output_metric_handlers (optional) an array of handlers for output metrics from this check

Examples

sensu_check 'cron' do
  command '/bin/true'
  cron '@hourly'
  subscriptions %w(dad_jokes)
  handlers %w(pagerduty email)
  annotations(runbook: 'https://www.xkcd.com/378/')
  publish false
  ttl 100
  high_flap_threshold 60
  low_flap_threshold 20
  action :create
end


# Since this is a ruby based script, the check below defines two runtime_assets.
# One is the ruby-runtime asset, the other is the actual disk usage asset
sensu_check 'disk' do
  command 'check-disk-usage.rb -t xfs -w 95 -c 99'
  interval 60
  subscriptions %w(linux)
  handlers %w(pagerduty splunk)
  publish true
  ttl 100
  runtime_assets ['sensu-ruby-runtime', 'sensu-plugins-disk-checks']
  action :create
end

sensu_handler

Properties

• command the command to run only allowd if type is pipe
• env_vars an array of environment variables to use with command execution only allowed if type is pipe
• filters an array of Sensu event filter names to use
• handlers an array of Sensu event handler names to use for events
• mutator mutator to use to mutate event data for the handler
• namespace the Sensu RBAC namespace that this check belongs to, default: default
• runtime_assets An array of Sensu assets required at runtime for the execution of the command
• secrets an array of hashes of name/secret pairs to use with command execution
• socket the socket definition scope, used to configure the TCP/UDP handler socket
• timeout the handler execution duration timeout in seconds, only used with pipe and tcp types
• type required handler type, one of pipe, tcp, udp or set

Examples

sensu_handler 'tcp_handler' do
  type 'tcp'
  socket({host: '10.0.1.99',
          port: 4444
         })
  timeout 30
end

sensu_hook

Used to define hooks for sensu checks

Properties

• command required command to be executed
• namespace the Sensu RBAC namespace that this check belongs to, default: default
• timeout duration timeout in seconds (hard stop)
• stdin If the Sensu agent writes JSON serialized Sensu entity and check data to the command process’ STDIN. The command must expect the JSON data via STDIN, read it, and close STDIN. This attribute cannot be used with existing Sensu check plugins, nor Nagios plugins etc, as Sensu agent will wait indefinitely for the hook process to read and close STDIN

Examples

sensu_hook 'restart_nginx' do
  command 'sudo systemctl start nginx'
  timeout 60,
  stdin false
end

sensu_hook 'process_tree' do
  command 'ps aux'
  timeout 60,
  stdin false
end

sensu_filter

Used to define filters for sensu checks

Properties

• filter_action required action to take with the event if the filter statements match. One of: allow, deny
• expressions required filter expressions to be compared with event data.
• namespace the Sensu RBAC namespace that this check belongs to, default: default
• when the when definition scope, used to determine when a filter is applied with time windows

Examples

sensu_filter 'production_filter' do
  filter_action 'allow'
  expressions [
    "event.Entity.Environment == 'production'",
  ]
end

sensu_filter 'state_change_only' do
  filter_action 'allow'
  expressions [
    "event.Check.Occurrences == 1"
  ]
end

sensu_mutator

A handler can specify a mutator to transform event data. This resource can define named resources to be used by handlers.

Properties

• command required the command to run
• env_vars an array of environment variables to use with command execution
• namespace the Sensu RBAC namespace that this check belongs to, default: default
• secrets an array of hashes of name/secret pairs to use with command execution
• timeout the execution duration timeout in seconds #### Examples The following defines a filter that uses a Sensu plugin called example_mutator.rb to modify event data prior to handling the event.

sensu_mutator 'example-mutator' do
  command 'example_mutator.rb'
  timeout 60
end

sensu_asset

At runtime the agent can sequentially fetch assets and store them in its local cache but these must first be defined by name for the sensu backend.

Properties

• filters a set of filter criteria used by the agent to determine of the asset should be installed.
• sha512 required the checksum of the asset.
• url required the URL location of the asset.
• namespace the Sensu RBAC namespace that this check belongs to, default: default

Examples

sensu_asset 'asset_example' do
  url 'http://example.com/asset/example.tar'
  sha512 '4f926bf4328fbad2b9cac873d117f771914f4b837c9c85584c38ccf55a3ef3c2e8d154812246e5dda4a87450576b2c58ad9ab40c9e2edc31b288d066b195b21b'
  filters [
    "System.OS==linux"
  ]
end

sensu_namespace

A Namespace partitions resources within Sensu, this replaces organizations/environments. The resource name is the namespace name.

Examples

sensu_namespace 'example_namespace' do
  action :create
end

sensu_entity

An entity is a representation of anything that needs to be monitored. From Sensu Go 6.0.0 onward, updates of an existing agent entity's subscriptions, labels, annotations, and attributes should be done via this resource, as updating via sensu_agent will be ignored.

Properties

• entity_class required the entity type, should be either agent or proxy.
• deregister Whether or not the entity should be removed from Sensu once the Sensu agent process's keepalive dies. Not needed for proxy entities.
• deregistration Hash of handlers for use when the entity is deregistered. Not needed for proxy entities.
• namespace the Sensu RBAC namespace that this check belongs to, default: default
• redact List of items to redact from log messages and dashboard. If a value is provided, it overwrites the default list of items to be redacted.
• sensu_agent_version Version of the agent entity running on the machine. Not needed for proxy entities.
• subscriptions An array of subscriptions. If no subscriptions are provided, it defaults to an entity-specific subscription list: [entity:{ID}].
• system A hash of system information about the entity. A full list of attributes that can be used can be found here.
• user Sensu RBAC username used by the entity.

Examples

This example assumes that you've designed your proxy check to look for subscriptions (e.g., "entity.subscriptions.indexOf('hypervisor') >= 0" for the proxy_requests' entity_attributes).
rb
sensu_entity 'example-hypervisor-entity' do
entity_class 'proxy'
subscriptions ['hypervisor']
redact ['snmp_community_string']
system(
'hostname': 'example-hypervisor',
'platform': 'Citrix Hypervisor',
'platform_version': '8.1.0',
'network': {
'interfaces': [
{
'name': 'lo',
'addresses': ['127.0.0.1/8'],
},
{
'name': 'xapi0',
'mac': '52:54:00:20:1b:3c',
'addresses': ['172.0.1.72/24'],
},
],
},
)
end

This example assumes you've designed your proxy check to look for labels (e.g., "entity.labels.proxy_type == 'website'" for the proxy_requests' entity_attributes).
rb
sensu_entity 'example-website-entity' do
entity_class 'proxy'
labels (
'proxy_type': 'website',
'url': 'https://my-website-url.com'
)
end


sensu_role

The combination of Roles and RoleBindings grant users and groups permissions to resources within a namespace. Roles describe which resources and verbs a subject has access to.

Properties

• rules required an array of hashes, describing permissions granted by the role. See Role and Cluster Role Rule attribute specification for details.

sensu_role_binding

The combination of Roles and RoleBindings grant users and groups permissions to resources within a namespace. RoleBindings describe the association of a role with one or more subjects.

Properties

• role_name required the name of the role
• role_type required the role type, either Role or ClusterRole
• subjects required an array of hashes, each describing the name and type of a subject which is granted the permissions described by the named role.

See Role binding and Cluster Role binding specification for additional details.

sensu_cluster_role

The combination of ClusterRoles and ClusterRoleBindings grant users and groups permissions to resources across all namespaces. ClusterRoles describe which resources and verbs a subject has access to.

Properties

• rules required an array of hashes, describing permissions granted by the role. See Role and Cluster Role Rule attribute specification for details.

sensu_cluster_role_binding

The combination of ClusterRoles and ClusterRoleBindings grant users and groups permissions to resources within a namespace. ClusterRoleBindings describe the association of a role with one or more subjects.

Properties

• role_name required the name of the role
• role_type required the role type, either Role or ClusterRole
• subjects required an array of hashes, each describing the name and type of a subject which is granted the permissions described by the named role.

sensu_postgres_config

Configure Sensu to store events in a PostgreSQL database.

Properties

• dsn required A string specifying the data source names as a URL or PostgreSQL connection string.
• pool_size An integer value for the maximum number of PostgreSQL connections to maintain.

See PostgreSQL docs for more information about connection strings.

Examples

sensu_postgres_config 'default' do
    dsn "postgresql://sensu:pgtesting123@127.0.0.1:5432/sensu_events?sslmode=disable"
    pool_size 10
end

sensu_active_directory

An active directory configuration to be applied to Sensu Go (commercial feature).

Properties

• groups_prefix Prefix for groups to include.
• username_prefix Prefix for users to include.
• servers required An array of active directory servers to connect to, including all of their properties.

Examples

sensu_active_directory 'active_directory' do
  servers [{
    'host': '127.0.0.1',
    'group_search': {
      'base_dn': 'dc=acme,dc=org',
    },
    'user_search': {
      'base_dn': 'dc=acme,dc=org',
    },
  }]
end

sensu_secret

Create a secret that Sensu can grab from a secret provider so that sensitive information is not exposed (commercial feature).

Properties

• id required The key to use to retrive the secret. For the Env secrets provider, this is the environment variable. For the Vault secrets provider, this is the path and key in the form of secret/path#key. Currently, the Vault secrets provider does not support any base engine paths other than "secret/" for v2 K/V secrets engine.
• namespace the Sensu RBAC namespace that this check belongs to, default: default
• secrets_provider required Name of the provider, all in lowercase, ex: 'env', 'vault'

Examples

Environment secret referencing the environment variable CONSUL_TOKEN on the backend server:

sensu_secret 'sensu-consul-token' do
  id 'CONSUL_TOKEN'
  secrets_provider 'env'
end

Vault secret referencing the key token at the path secret/consul:
rb
sensu_secret 'sensu-consul-token' do
id 'secret/consul#token'
secrets_provider 'vault'
end


sensu_secrets_provider

Create a secret provider for Sensu to connect to for secrets (commercial feature). Currently supports only Vault integration or Sensu Go's built-in secrets provider.

Either a token or a TLS hash must be provided.

Properties

• address required Vault server address.
• max_retries Maximum number of times to retry connecting to the Vault provider.
• provider_type Secret provider to use. Default: 'Env'
• rate_limiter Hash of rate and burst limits for the Vault API.
• timeout Connection timeout for provider.
• tls Hash of certificate information required to access Vault.
• token Vault token to use for authentication.
• version Version of the Vault KV secrets engine you're trying to access. Default: 'v2'

Examples

Minimal with token:

sensu_secrets_provider 'vault' do
  address 'https://vaultserver.example.com:8200'
  provider_type 'VaultProvider'
  token 'yourVaultToken'
end

Complete with TLS:

sensu_secrets_provider 'vault' do
  address 'https://vaultserver.example.com:8200'
  max_retries 2
  provider_type 'VaultProvider'
  rate_limiter(
    'limit': 10,
    'burst': 100
  )
  tls('ca_cert': '/path/to/your/ca.pem',
      'client_cert': '/path/to/backend/pem/for/vault.pem',
      'client_key': '/path/to/backend/key/for/vault.pem',
      'cname': 'sensu-backend.example.com'
     )
  timeout '60s'
  version 'v2'
end

License & Authors

If you would like to see the detailed LICENSE click [here](./LICENSE).

• Author:: Sensu support@sensuapp.com

Copyright (c) 2018 Sensu

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.