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

[APM] Document Agent Configuration API #57005

Open
graphaelli opened this issue Feb 6, 2020 · 10 comments
Open

[APM] Document Agent Configuration API #57005

graphaelli opened this issue Feb 6, 2020 · 10 comments
Labels

Comments

@graphaelli
Copy link
Member

@graphaelli graphaelli commented Feb 6, 2020

Describe the feature:

APM provides a central configuration UI but building automation around it would be simpler if the API in Kibana was documented for use in integrations with user tools.

@graphaelli graphaelli added the Team:apm label Feb 6, 2020
@elasticmachine

This comment has been minimized.

Copy link
Contributor

@elasticmachine elasticmachine commented Feb 6, 2020

Pinging @elastic/apm-ui (Team:apm)

@graphaelli graphaelli changed the title [APM] Document central configuration API [APM] Document Agent Configuration API Feb 6, 2020
@sqren

This comment has been minimized.

Copy link
Member

@sqren sqren commented Feb 11, 2020

Good idea @graphaelli!
@bmorelli25 If you can give me a few pointers (where should this go and if we have any conventions for API docs) I can take a stab at it.

@bmorelli25

This comment has been minimized.

Copy link
Member

@bmorelli25 bmorelli25 commented Feb 12, 2020

@sqren, I've already created some documentation for this API: https://www.elastic.co/guide/en/apm/server/current/agent-configuration-api.html
You can just add to that page. Happy to help.

We do have some new-ish conventions for Elastic API documentation. I'll dig those up.

@bmorelli25

This comment has been minimized.

Copy link
Member

@bmorelli25 bmorelli25 commented Feb 12, 2020

@sqren

This comment has been minimized.

Copy link
Member

@sqren sqren commented Feb 12, 2020

I've already created some documentation for this API:

Sorry, I should've been more clear. This is in the context of the API in Kibana - not APM Server. We have a few more things we can document (most importantly "Create config"):

Create config

POST /api/apm/settings/agent-configuration/new

Note: should this endpoint be renamed? The "/new" part looks a bit off

Delete config

DELETE /api/apm/settings/agent-configuration/{configurationId}

Update existing config

PUT /api/apm/settings/agent-configuration/{configurationId}

List configs

GET /api/apm/settings/agent-configuration

Search configs

POST /api/apm/settings/agent-configuration/search
@bmorelli25

This comment has been minimized.

Copy link
Member

@bmorelli25 bmorelli25 commented Feb 12, 2020

Ahh, gotcha. Kibana has a REST API documentation section, but I'm hesitant to group this with the content there, as it would be away from the other APM content. Agent config is documented in the Kibana reference here: https://www.elastic.co/guide/en/kibana/master/agent-configuration.html, but I don't think it makes sense to group the API content there. What about creating a new subheading under the APM heading called API? Something like this:
Screen Shot 2020-02-12 at 1 33 34 PM

@sqren

This comment has been minimized.

Copy link
Member

@sqren sqren commented Feb 12, 2020

I think that makes sense. I like that it's part of the APM docs and not the general Kibana API docs 👍

@sqren

This comment has been minimized.

Copy link
Member

@sqren sqren commented Feb 14, 2020

@bmorelli25 If you can create a branch with the initial structure I can fill in docs for the endpoints and then we can go over it together?

@bmorelli25

This comment has been minimized.

Copy link
Member

@bmorelli25 bmorelli25 commented Feb 14, 2020

Fun idea. Let's do it

@sqren

This comment has been minimized.

Copy link
Member

@sqren sqren commented Feb 14, 2020

Great, thanks! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
4 participants
You can’t perform that action at this time.