Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add metadata_entrypoint to API reference #6938

Merged
merged 1 commit into from
Jun 22, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions datadog_checks_base/datadog_checks/base/checks/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
1 change: 1 addition & 0 deletions docs/developer/base/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
- service_check
- event
- set_metadata
- metadata_entrypoint

## Stubs

Expand Down