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

Documentation on how to write monitoring metrics doesn't help much #1142

Closed
jinwoo opened this issue May 1, 2018 · 3 comments
Closed

Documentation on how to write monitoring metrics doesn't help much #1142

jinwoo opened this issue May 1, 2018 · 3 comments
Assignees
Labels
type: docs Improvement to the documentation for an API.

Comments

@jinwoo
Copy link
Contributor

jinwoo commented May 1, 2018

The document clearly says I have to use monitoring.projects.timeSeries.create(), which is good: https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/create

But it doesn't have any sample code for what the actual payload should be within the resource field: what timeSeries, timeSeries/metric, and timeSeries/metric/labels fields should be like, etc. It's really frustrating to figure them out by trials and errors.

@JustinBeckwith
Copy link
Contributor

I have some good news :) . See #1141.

@jinwoo
Copy link
Contributor Author

jinwoo commented May 1, 2018

Awesome. But even with that change, things are still not clear. E.g. what the timeSeries/metric/labels field should look like? The type definition says just any :(

@JustinBeckwith JustinBeckwith added docs type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. labels May 28, 2018
@JustinBeckwith JustinBeckwith added type: docs Improvement to the documentation for an API. and removed docs labels Jun 12, 2018
@AVaksman
Copy link
Contributor

@jinwoo
Please see TimeSeries docs page.
I believe there is a good description of all TimeSeries object components.

Please confirm if this helps you.

@JustinBeckwith JustinBeckwith removed the type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. label Jun 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Improvement to the documentation for an API.
Projects
None yet
Development

No branches or pull requests

3 participants