# Functions
AddEntitySubscription appends the entity subscription (using the format "entity:entityName") to the subscriptions of an entity.
AddValidPipelineWorkflowFilterReference adds a ResourceReference to the list of valid resource references for filters.
AddValidPipelineWorkflowHandlerReference adds a ResourceReference to the list of valid resource references for handlers.
AddValidPipelineWorkflowMutatorReference adds a ResourceReference to the list of valid resource references for mutators.
APIKeyFields returns a set of fields that represent that resource.
AssetFields returns a set of fields that represent that resource.
CheckConfigFields returns a set of fields that represent that resource.
No description provided by the author
ClusterRoleBindingFields returns a set of fields that represent that resource.
ClusterRoleFields returns a set of fields that represent that resource.
ContextNamespace returns the namespace injected in the context.
ContextPipeline returns the pipeline injected in the context.
ContextPipelineWorkflow returns the pipeline workflow injected in the context.
DefaultTessenConfig returns the default tessen configuration.
EntityFields returns a set of fields that represent that resource.
EnvVarsToMap converts a list of FOO=BAR key-value pairs into a map.
EventFields returns a set of fields that represent that resource.
EventFilterFields returns a set of fields that represent that resource.
EventsByEntityName can be used to sort a given collection of events by entity name (and secondarily by check name.).
EventsByLastOk can be used to sort a given collection of events by time it last received an OK status.
EventsBySeverity can be used to sort a given collection of events by check status and timestamp.
EventsByTimestamp can be used to sort a given collection of events by time it occurred.
ExtensionFields returns a set of fields that represent that resource.
FakeHandlerCommand takes a command and (optionally) command args and will execute the TestHelperHandlerProcess test within the package FakeHandlerCommand is called from.
FakeMutatorCommand takes a command and (optionally) command args and will execute the TestHelperMutatorProcess test within the package FakeMutatorCommand is called from.
FixtureAdhocRequest returns a testing fixture for an AdhocRequest struct.
FixtureAPIKey returns a testing fixture for an APIKey struct.
FixtureAsset given a name returns a valid asset for use in tests.
FixtureCheck returns a fixture for a Check object.
FixtureCheckConfig returns a fixture for a CheckConfig object.
FixtureCheckRequest returns a fixture for a CheckRequest object.
FixtureClaims returns a testing fixture for a JWT claims.
FixtureClusterRole returns a partial role.
FixtureClusterRoleBinding creates a ClusterRoleBinding for testing.
FixtureDenyEventFilter returns a Filter fixture for testing.
FixtureEntity returns a testing fixture for an Entity object.
FixtureEvent returns a testing fixture for an Event object.
FixtureEventFilter returns a Filter fixture for testing.
FixtureExtension given a name returns a valid extension for use in tests.
FixtureHandler returns a Handler fixture for testing.
FixtureHealthResponse returns a HealthResponse fixture for testing.
FixtureHook returns a fixture for a Hook object.
FixtureHookConfig returns a fixture for a HookConfig object.
FixtureHookList returns a fixture for a HookList object.
FixtureMetricPoint returns a testing fixture for a Metric Point object.
FixtureMetrics returns a testing fixture for a Metrics object.
FixtureMetricTag returns a testing fixture for a Metric Tag object.
FixtureMutator returns a Mutator fixture for testing.
FixtureNamespace returns a mocked namespace.
FixturePipeline returns a testing fixture for a Pipeline object.
FixturePipelineReference returns a testing fixture for a ResourceReference object referencing a corev2.Pipeline.
FixtureProxyRequests returns a fixture for a ProxyRequests object.
FixtureRole returns a partial role.
FixtureRoleBinding creates a RoleBinding for testing.
FixtureRoleRef creates a RoleRef for testing.
FixtureRule returns a partial rule.
FixtureSetHandler returns a Handler fixture for testing.
FixtureSilenced returns a testing fixture for a Silenced event struct.
FixtureSocketHandler returns a Handler fixture for testing.
FixtureSubject creates a Subject for testing.
FixtureTokens given an access and refresh tokens returns valid tokens for use in tests.
FixtureUser returns a testing fixture for an Entity object.
FixtureVersion returns a Version fixture for testing.
No description provided by the author
GetEntitySubscription returns the entity subscription, using the format "entity:entityName".
HandlerFields returns a set of fields that represent that resource.
HookConfigFields returns a set of fields that represent that resource.
LoadCACerts takes the path to a certificate bundle file in PEM format and try to create a x509.CertPool out of it.
MutatorFields returns a set of fields that represent that resource.
NamespaceFields returns a set of fields that represent that resource.
No description provided by the author
NewAsset creates a new Asset.
No description provided by the author
No description provided by the author
NewCheck creates a new Check.
NewCheckConfig creates a new CheckConfig.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewEntity creates a new Entity.
No description provided by the author
NewEvent creates a new Event.
NewEventFilter creates a new EventFilter.
No description provided by the author
No description provided by the author
NewExtension intializes an extension with the given object meta.
No description provided by the author
NewHandler creates a new Handler.
No description provided by the author
No description provided by the author
NewKeepaliveRecord initializes and returns a KeepaliveRecord from an entity and its expiration time.
No description provided by the author
NewMutator creates a new Mutator.
No description provided by the author
NewObjectMeta makes a new ObjectMeta, with Labels and Annotations assigned empty maps.
NewObjectMetaP is the pointer-returning version of NewObjectMeta.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewRole creates a new Role.
NewRoleBinding creates a new RoleBinding.
No description provided by the author
No description provided by the author
No description provided by the author
NewSilenced creates a new Silenced entry.
No description provided by the author
No description provided by the author
PageContinueFromContext returns the continue token stored in the given context, if any.
PageSizeFromContext returns the page size stored in the given context, if any.
PipelineFields returns a set of fields that represent that resource.
PipelineWorkflowFromHandler takes a Handler, converts it to a PipelineWorkflow and then returns it.
RoleBindingFields returns a set of fields that represent that resource.
RoleFields returns a set of fields that represent that resource.
SetContextFromResource takes a context and a multi-tenant resource, adds the namespace to the context, and returns the udpated context.
SilencedFields returns a set of fields that represent that resource.
SilencedName returns the canonical name for a silenced entry.
SortCheckConfigsByName can be used to sort a given collection of checks by their names.
SortCheckConfigsByPredicate can be used to sort a given collection using a given predicate.
No description provided by the author
SortEntitiesByID can be used to sort a given collection of entities by their IDs.
SortEntitiesByLastSeen can be used to sort a given collection of entities by last time each was seen.
SortEntitiesByPredicate can be used to sort a given collection using a given predicate.
SortEventFiltersByName can be used to sort a given collection of event filter by their names.
SortEventFiltersByPredicate can be used to sort a given collection using a given predicate.
No description provided by the author
SortHandlersByName is used to sort a given collection of handlers by their names.
SortHandlersByPredicate is used to sort a given collection using a given predicate.
SortMutatorsByName is used to sort a given collection of mutators by their names.
SortMutatorsByPredicate is used to sort a given collection using a given predicate.
SortSilencedByBegin can be used to sort a given collection by their begin timestamp.
SortSilencedByExpireAt sorts silences by expiration timestamp where silences with expiration of 0 could never expire and are weighed heaviest, slightly less so if set to expire on resolve.
SortSilencedByName can be used to sort a given collection by their names.
SortSilencedByPredicate can be used to sort a given collection using a given predicate.
StandardClaims returns an initialized jwt.StandardClaims with the subject.
UserFields returns a set of fields that represent that resource.
ValidateAssetName validates that asset's name is valid.
ValidateEnvVars ensures that all the environment variables are well-formed.
ValidateInterval returns an error if the tessen interval is not within the upper and lower bound limits.
ValidateName validates the name of an element so it's not empty and it does not contains specical characters.
ValidateNameStrict validates the name of an element so it's not empty and it does not contains specical characters.
ValidateOutputMetricFormat returns an error if the string is not a valid metric format.
ValidateRoleRef checks that the role reference has a valid reference to either a Role or a ClusterRole.
No description provided by the author
ValidateSubjects checks that there is at least one subject, and all subjects have non-empty types and names.
ValidateSubscriptionName validates the name of a subscription so it's not empty and it does not contains special characters except for an optional ":".
# Constants
AccessTokenClaims contains the key name to retrieve the access token claims.
AccessTokenString is the key name used to retrieve the access token string.
AgentHandshakeType is the message type string for an AgentHandshake.
APIGroupName is the group name for this API.
APIKeysResource is the name of this resource type.
APIVersion is the version for this API.
AssetsResource is the name of this resource type.
AuthorizationAttributesKey is the key name used to store authorization attributes extracted from a request.
BackendCheckName is the name fo the check that is created when a backend event is generated from an error.
BackendHandshakeType is the message type string for a BackendHandshake.
CheckRequestType is the message type string for check request.
ChecksResource is the name of this resource type.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ClaimsKey contains key name to retrieve the jwt claims from context.
ClusterRoleBindingsResource is the name of this resource type.
ClusterRolesResource is the name of this resource type.
ClusterRoleType represents a ClusterRole in a RoleRef.
CoreEdition represents the Sensu Core Edition (CE) <DEPRECATED>.
DefaultEventFilterAction is the default action for filters.
DefaultKeepaliveTimeout specifies the default keepalive timeout.
DefaultSplayCoverage is the default splay coverage for proxy check requests.
DefaultTessenInterval is the default interval at which tessen will phone home, in seconds.
EditionHeader represents the HTTP header containing the edition value <DEPRECATED>.
EntitiesResource is the name of this resource type.
EntityAgentClass is the name of the class given to agent entities.
EntityBackendClass is the name of the class given to backend entities.
EntityProxyClass is the name of the class given to proxy entities.
EntityServiceClass is the name of the class given to BSM service entities.
No description provided by the author
No description provided by the author
EtcdScheduler indicates that a check is scheduled with etcd leases and watchers.
EventFailingState indicates failing check result status.
EventFilterActionAllow is an action to allow events to pass through to the pipeline.
EventFilterActionDeny is an action to deny events from passing through to the pipeline.
EventFiltersResource is the name of this resource type.
EventFlappingState indicates a rapid change in check result status.
EventPassingState indicates successful check result status.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
EventsResource is the name of this resource type.
ExtensionsResource is the name of this resource type.
GraphiteOutputMetricFormat is the accepted string to represent the output metric format of Graphite Plain Text.
GroupType represents a group object in a subject.
HandlerPipeType represents handlers that pipes event data // into arbitrary commands via STDIN.
HandlerSetType represents handlers that groups event handlers, making it easy to manage groups of actions that should be executed for certain types of events.
HandlersResource is the name of this resource type.
HandlerTCPType represents handlers that send event data to a remote TCP socket.
HandlerUDPType represents handlers that send event data to a remote UDP socket.
HookRequestType is the message type string for hook request.
HooksResource is the name of this resource type.
InfluxDBOutputMetricFormat is the accepted string to represent the output metric format of InfluxDB Line.
No description provided by the author
KeepaliveCheckName is the name of the check that is created when a keepalive timeout occurs.
KeepaliveHandlerName is the name of the handler that is executed when a keepalive timeout occurs.
LocalSelfUserResource represents a local user trying to view itself or change its password.
LowerBound is the minimum interval that tessen will phone home, in seconds.
ManagedByLabel is used to identify which client was used to create/update a resource.
MemoryScheduler indicates that a check is scheduled in-memory.
No description provided by the author
No description provided by the author
No description provided by the author
MutatorsResource is the name of this resource type.
NagiosOutputMetricFormat is the accepted string to represent the output metric format of Nagios Perf Data.
NamespaceKey contains the key name to retrieve the namespace from context.
NamespacesResource is the name of this resource type.
NamespaceTypeAll represents an empty namespace, used to represent a request across all namespaces.
OpenTSDBOutputMetricFormat is the accepted string to represent the output metric format of OpenTSDB Line.
PageContinueKey contains the continue token used in pagination.
PageSizeKey contains the page size used in pagination.
PaginationContinueHeader is the name of the header used by the API to return a potential continue token when paginating.
PipelineKey contains the key name to retrieve the pipeline from context.
PipelinesResource is the name of this resource type.
PipelineWorkflowKey contains the key name to retrieve the pipeline workflow from context.
No description provided by the author
PostgresScheduler indicates that a check is scheduled with postgresql, using transactions and asynchronous notification (NOTIFY).
PrometheusOutputMetricFormat is the accepted string to represent the output metric format of Prometheus Exposition Text Format.
Redacted is filled in for fields that contain sensitive information.
RefreshTokenClaims contains the key name to retrieve the refresh token claims.
RefreshTokenString contains the key name to retrieve the refresh token string.
RegistrationCheckName is the name of the check that is created when an entity sends a keepalive and the entity does not yet exist in the store.
RegistrationHandlerName is the name of the handler that is executed when a registration event is passed to pipelined.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ResourceAll represents all possible resources.
RoleBindingsResource is the name of this resource type.
RolesResource is the name of this resource type.
RoleType represents a Role in a RoleRef.
SilencedResource is the name of this resource type.
StoreKey contains the key name to retrieve the etcd store from within a context.
TessenResource is the name of this resource type.
UpperBound is the maximum interval that tessen will phone home, in seconds.
UsersResource is the name of this resource type.
UserType represents a user object in a subject.
VerbAll represents all possible verbs.
# Variables
AssetNameRegex used to validate name of asset.
AssetNameRegexStr used to validate name of asset.
CheckHookRegex used to validate type of check hook.
CheckHookRegexStr used to validate type of check hook.
CommonCoreResources represents the common "core" resources found in a namespace.
DefaultCipherSuites overrides the default cipher suites in order to disable CBC suites (Lucky13 attack) this means TLS 1.1 can't work (no GCM) additionally, we should only use perfect forward secrecy ciphers.
DefaultRedactFields contains the default fields to redact.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
EventFilterAllActions is a list of actions that can be used by filters.
NameRegex is used to validate the name of a resource.
OutputMetricFormats represents all the accepted output_metric_format's a check can have.
Severities used to validate type of check hook.
StrictNameRegex is used to validate names of resources using a strict subset of charset.
SubscriptionNameRegex is used to validate the name of a subscription, which can contain a single ":" character in case of an entity subscription (e.g.
URLPrefix is the URL prefix of this API.
# Structs
No description provided by the author
No description provided by the author
An APIKey is an api key specification.
APIKeyResponse is returned by the Sensu 7.x apikeys API.
Asset defines an asset and optionally a list of assets (builds) that agents install as a dependency for a check, handler, mutator, etc.
AssetBuild defines an individual asset that an asset can install as a dependency for a check, handler, mutator, etc.
An AssetList represents a list of assets for a CheckRequest.
AuthProviderClaims contains information from the authentication provider.
A BackendHandshake is the first message sent by a Backend on a Transport in a Session.
A Check is a check specification and optionally the results of the check's execution.
CheckConfig is the specification of a check.
CheckHistory is a record of a check execution and its status.
A CheckRequest represents a request to execute a check.
Claims represents the JWT claims.
ClusterHealth holds cluster member status info.
ClusterRole applies to all namespaces within a cluster.
ClusterRoleBinding grants the permissions defined in a ClusterRole referenced to a user or a set of users.
Deregistration contains configuration for Sensu entity de-registration.
Entity is the Entity supplying the event.
An Event is the encapsulating type sent across the Sensu websocket transport.
EventFilter is a filter specification.
Extension is a registered sensu extension.
A Handler is a handler specification.
HandlerSocket contains configuration for a TCP or UDP handler.
HealthResponse contains cluster health and cluster alarms.
A Hook is a hook specification and optionally the results of the hook's execution.
HookConfig is the specification of a hook.
No description provided by the author
A KeepaliveRecord is a tuple of an entity name and the time at which the entity's keepalive will next expire.
A MetricPoint represents a single measurement.
A Metrics is an event metrics payload specification.
A MetricTag adds a dimension to a metric point.
Represents an instance of a metric filter to evaluate.
A rule to apply to a metric to determine its status.
Represents the measurement tags to match.
A Mutator is a mutator specification.
Namespace represents a virtual cluster.
Network contains information about the system network interfaces that the Agent process is running on, used for additional Entity context.
NetworkInterface contains information about a system network interface.
ObjectMeta is metadata all persisted objects have.
Pipeline represents a named collection of pipeline workflows.
PipelineWorkflow represents a workflow of filters, mutator, & handler to use in a pipeline.sensu:nogen.
PostgresHealth holds postgres store status info.
Process contains information about a local process.
A ProxyRequests represents a request to execute a proxy check.
ResourceReference represents a reference to another resource.sensu:nogen.
Role applies only to a single namespace.
RoleBinding grants the permissions defined in a Role referenced to a user or a set of users.
RoleRef maps groups to Roles or ClusterRoles.
Rule holds information that describes an action that can be taken.
A Secret is a secret specification.
Silenced is the representation of a silence entry.
No description provided by the author
System contains information about the system that the Agent process is running on, used for additional Entity context.
TessenConfig is the representation of a tessen configuration.
TimeWindowDays defines the days of a time window.
No description provided by the author
TimeWindowTimeRange defines the time ranges of a time.
TimeWindowWhen defines the "when" attributes for time windows.
TLSOptions holds TLS options that are used across the varying Sensu components.
Tokens contains the structure for exchanging tokens with the API.
TypeMeta is information that can be used to resolve a data type.
User describes an authenticated user.
Version holds the current etcd server and cluster version, and the sensu-backend version.
# Interfaces
No description provided by the author
No description provided by the author
No description provided by the author
AuthProvider represents an abstracted authentication provider.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ConstrainedResource defines a resources that has contraints on it's attributes.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Fielder includes a set of fields that represent a resource.
No description provided by the author
No description provided by the author
No description provided by the author
MultitenantResource is a object that belongs to a namespace.
No description provided by the author
Resource represents a Sensu resource.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Type aliases
An AgentHandshake is the first message sent by a Backend on a Transport in a Session.
DEPRECATED, DO NOT USE! Events should be ordered FIFO.
No description provided by the author
No description provided by the author