Honeycomb Health Check

Honeycomb Health Checks use Triggers to monitor a service's health during testing. Before configuring the Health Check, identify which Trigger you want to use. For this example, we’ll use a Trigger called frontend-service.

1. Open the Health Checks page in the Gremlin web app and click + Health Check.
2. If you’ve already authenticated Honeycomb in Gremlin, skip the following steps. Otherwise:some text
   1. Follow the instructions in the Honeycomb documentation to create an API key. This needs to be a configuration key.
   2. In the Gremlin web app, click the Observability Tool drop-down and select Custom.
   3. Enter a name in the Observability Tool Nickname box, such as “Honeycomb.”
   4. Under Does this observability tool have multiple regions, select No.
   5. Under Is this observability tool behind a firewall or on-prem, select No.
   6. In the Authentication Endpoint box, enter https://api.honeycomb.io/.
   7. Click + Add Header to add a new HTTP header.
   8. In the Key field, enter X-Honeycomb-Team. In the Value field, enter your Honeycomb API key.
   9. Click Save.
3. Click Next.
4. Enter a name for the Health Check.
5. In the Monitor or Alert URL box, enter the URL for your Trigger. For example, if your Trigger is named frontend-service, you would enter https://api.honeycomb.io/1/triggers/frontend-service.
6. Click Test Connection. Gremlin will send a GET request and display the JSON response. 
7. Adjust the Success Evaluation criteria to your needs. This will depend on your Trigger and its contents, but for a basic check, you can use the triggered boolean property. To do so, enter the following values:some text
   1. Key: .[0][‘triggered’]
   2. Key Type: Boolean
   3. Comparator: =
   4. Value: false
   5. For custom and more advanced criteria, see adding success evaluation criteria.
8. Click Test Evaluation to send a test request. This will ensure that your criteria are valid and that the response meets them.
9. Click Create Health Check.

‍