Silenced API

[portertech]

Sensu 1.X provides a set of API endpoints for managing Event silencing, the "Silenced API". Sensu 1.X silencing is based on Sensu client subscription and check name. Silencing also supports a basic wildcard/splat (match all) for the client subscription and/or check name.

The Sensu 1.X Silenced API documentation can be found at: https://sensuapp.org/docs/1.0/api/silenced-api.html#sensu-silenced-api

The Sensu 1.X Silenced API Ruby code can be found at: https://github.com/sensu/sensu/blob/master/lib/sensu/api/routes/silenced.rb

To get an idea of what the Sensu 1.X server does, the Ruby code can be found at: https://github.com/sensu/sensu/blob/9059bf10125221cd4806cc0ad6758f43fe216e8b/lib/sensu/server/process.rb#L455-L496

The Sensu 2.X API must implement the Silenced API. The technical implementation will likely differ due to the change in storage technologies. Silencing in 2.X is based on Agent subscription and check name.

[portertech]

I will create the other, related, silencing ticket in the AM.

[portertech]

The Sensu 2.X backend Silenced implementation is fairly straightforward, we're just going to add a few notes here, instead of another ticket.

Eventd needs to check for the existence of Silenced Entries for an event, if one or more exists, mark the Event as "silenced".

Pipelined needs a built-in filter to exclude "silenced" Events. The filter is applied to all Event handlers (and their pipelines) unless a handler has "handle_silenced": true. The 1.X "handle_silenced" documentation can be found at: https://sensuapp.org/docs/1.0/reference/handlers.html#handler-attributes (under "handle_silenced")

[portertech]

eventd to determine if an event has been silenced, settings event.Silenced to true.

[palourde]

CoS

• [ ] Silenced entries can be managed through the API
• [ ] Events silenced by a silenced entry are identifiable so pipelined can easily act on it
• [ ] The actual filtering, done in pipelined, will be done later in a subsequent ticket

Tasks

• [ ] Implement the silenced store
• [ ] Implement the silenced API
  • [ ] GET /silenced
  • [ ] POST /silenced
  • [ ] GET /silenced/ids/:id
  • [ ] POST /silenced/clear
  • [ ] GET /silenced/subscriptions/:subscription
  • [ ] POST /silenced/checks/:check
• [ ] eventd verifies and marks an event as silenced if applicable (with a new silenced attribute?)

[mercul3s]

Should this work include managing silenced events with sensuctl, or just the web api for now?

[portertech]

@mercul3s just the web API for now. sensuctl silencing will be a separate ticket fo sho 👍