From 0b15fd2f9f1ee3f1c4e372a70739d559e0774aa4 Mon Sep 17 00:00:00 2001 From: Florimond Manca Date: Mon, 22 Jun 2020 12:28:02 +0200 Subject: [PATCH] Add `metadata_entrypoint` to API reference --- .../datadog_checks/base/checks/base.py | 11 +++++++++-- docs/developer/base/api.md | 1 + 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/datadog_checks_base/datadog_checks/base/checks/base.py b/datadog_checks_base/datadog_checks/base/checks/base.py index ca67f19e2b1b5..792bfcb037a81 100644 --- a/datadog_checks_base/datadog_checks/base/checks/base.py +++ b/datadog_checks_base/datadog_checks/base/checks/base.py @@ -641,9 +641,16 @@ def is_metadata_collection_enabled(): def metadata_entrypoint(cls, method): # type: (Callable[..., None]) -> Callable[..., None] """ - Mark a method as a metadata entrypoint. + Skip execution of the decorated method if metadata collection is disabled on the Agent. - This decorator provides automatic no-op behavior in case metadata collection is disabled on the Agent. + Usage: + + ```python + class MyCheck(AgentCheck): + @AgentCheck.metadata_entrypoint + def collect_metadata(self): + ... + ``` """ @functools.wraps(method) diff --git a/docs/developer/base/api.md b/docs/developer/base/api.md index cd682563ddcbd..d88f4abd4f986 100644 --- a/docs/developer/base/api.md +++ b/docs/developer/base/api.md @@ -17,6 +17,7 @@ - service_check - event - set_metadata + - metadata_entrypoint ## Stubs