search

DataDog / datadogpy

The Datadog Python library
https://datadoghq.com/
Other
612 stars 304 forks source link

Metric.send() docstring should mention POSIX seconds timestamp #693

Open codekiln opened 3 years ago

codekiln commented 3 years ago

Describe the bug In datadog.api.metrics.Metric.send, the docstring says the points parameter should be

a (timestamp, value) pair or list of (timestamp, value) pairs" ... api.Metric.send(metric='my.series', points=[(now, 15), (future_10s, 16)])

Consider adding the sentence I've bolded below from datadog-api-client-python in the docstring, to dispel any ambiguity about the supported timestamp formats:

Points relating to a metric. All points must be tuples with timestamp and a scalar value (cannot be a string). Timestamps should be in POSIX time in seconds, and cannot be more than ten minutes in the future or more than one hour in the past.

github-actions[bot] commented 2 years ago

Thanks for your contribution!

This issue has been automatically marked as stale because it has not had activity in the last 30 days. Note that the issue will not be automatically closed, but this notification will remind us to investigate why there's been inactivity. Thank you for participating in the Datadog open source community.

If you would like this issue to remain open:

  1. Verify that you can still reproduce the issue in the latest version of this project.

  2. Comment that the issue is still reproducible and include updated details requested in the issue template.