Skip to content

Add metrics docs to cli reference#27862

Merged
thaJeztah merged 1 commit intomoby:masterfrom
crosbymichael:metrics-docs
Nov 2, 2016
Merged

Add metrics docs to cli reference#27862
thaJeztah merged 1 commit intomoby:masterfrom
crosbymichael:metrics-docs

Conversation

@crosbymichael
Copy link
Contributor

This adds the cli docs for the metrics-addr flag and a small description on how it can be used.

We can add full api docs after this feature is removed from experimental as metrics and metric names can be modified or removed before then.

Fixes #27843

Signed-off-by: Michael Crosby crosbymichael@gmail.com

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know what your general approach to port allocation is, but if you don't have any particular preference I'd suggest grabbing a number off https://github.com/prometheus/prometheus/wiki/Default-port-allocations

This will help your users avoid clashes with other Prometheus exporters.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is just an example and if we set a default port we will register it with IANA ;)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thaJeztah do you just want to go ahead and register one?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let me /cc @mgoelzer who was looking at this

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need the word 'default'? Some other address&port isn't going to be chosen, right?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yup, I noticed that as well, should just be Set address .. I think

Fixes moby#27843

Signed-off-by: Michael Crosby <crosbymichael@gmail.com>
@crosbymichael
Copy link
Contributor Author

@thaJeztah this has been updated

Copy link
Member

@vdemeester vdemeester left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🐮

Copy link
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[1.13] add new documentation reference section for metrics API

6 participants