To enable and collect health checks and metrics, services must be configured with a “management token”.
Services must have ManagementToken configured. This is used to authorize access monitoring endpoints. If ManagementToken is not configured, monitoring endpoints will return the error
To access a monitoring endpoint, the requester must provide the HTTP header
Authorization: Bearer (ManagementToken).
ManagementToken in the appropriate section of
production: # Token to be included in all healthcheck requests. Disabled by default. # Server expects request header of the format "Authorization: Bearer xxx" ManagementToken: xxx
port (the listen port) and
ManagementToken in the
Manage section of
[Manage] # The management server responds to http://addr:port/status.json with # a snapshot of internal state. # Management server listening address (default 127.0.0.1) #address = 0.0.0.0 # Management server port number (default -1, server is disabled) #port = 8989 ManagementToken = xxx
The following services also support monitoring. Set
ManagementToken in the respective yaml config file for each service.
The content of this documentation is licensed under the
Commons Attribution-Share Alike 3.0 United States licence.
Code samples in this documentation are licensed under the Apache License, Version 2.0.