Service Check Submission: Agent Check

To submit a service check to Datadog within a custom Agent check, use the predefined service_check() function in the AgentCheck class.

self.service_check(name, status, tags=None, hostname=None, message=None)

Find below the different parameters and data types available for the service_check() function:

Example

Here is an example of a dummy Agent check sending only one service check periodically. Refer to the dedicated Writing a Custom Agent Check documentation to learn more.

1. Create a new directory, service_check_example.d/, in the conf.d/ folder of your Agent.

2. In your service_check_example.d/ folder, create an empty configuration file named service_check_example.yaml with the following content:

   instances: [{}]
   

3. Up one level from the conf.d/ folder, go to the checks.d/ folder.

4. Within this folder, create a custom check file named service_check_example.py with the content below:

   service_check_example.py

   Copy

   from datadog_checks.base import AgentCheck
   
   __version__ = "1.0.0"
   
   class MyClass(AgentCheck):
       def check(self, instance):
           self.service_check('example_service_check', 0, message='Example application is up and running.')
       

5. Restart the Agent

6. Ensure that your custom check is correctly running with the Agent status command. You should see something like this:

   =========
   Collector
   =========
   
     Running Checks
     ==============
   
       (...)
   
       service_check_example (1.0.0)
       -----------------------------
         Instance ID: service_check_example:d884b5186b651429 [OK]
         Total Runs: 1
         Metric Samples: Last Run: 0, Total: 0
         Events: Last Run: 0, Total: 0
         Service Checks: Last Run: 1, Total: 1
         Average Execution Time : 2ms
   
       (...)
   

7. Finally, go to your Datadog Service Check summary page to see your Service Check reporting:

Further reading

Additional helpful documentation, links, and articles:

Write an Agent Custom CheckDOCUMENTATION