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

Official Definitions for Transaction and Trace #297

Closed
gingerwizard opened this issue Nov 10, 2017 · 6 comments · Fixed by #549
Closed

Official Definitions for Transaction and Trace #297

gingerwizard opened this issue Nov 10, 2017 · 6 comments · Fixed by #549
Assignees

Comments

@gingerwizard
Copy link

Request for official definitions for these in the docs. There seems to be some variation depending on the agent. This is more useful for messaging and when communicating in the field.

@asawariS @jamiesmith

@roncohen
Copy link
Contributor

@gingerwizard there are some big naming changes coming up, we'll make sure we get a proper definition written after.

@gingerwizard
Copy link
Author

@roncohen if would be nice to know how the schema changes as well between rc2 and GA. Nothing formal just some of the big points. I suspect it will be easier for us to recapture our dataset.

@roncohen
Copy link
Contributor

roncohen commented Dec 6, 2017

@gingerwizard
Copy link
Author

@roncohen super useful thanks.

@simitt
Copy link
Contributor

simitt commented Jan 24, 2018

We currently embed the json spec for the input API in the official docs for transactions and errors.
The embedded schema definitions contain descriptions for the objects and keys, e.g.
screen shot 2018-01-24 at 16 41 07

I'd appreciate if we werent duplicating descriptions, as this gets easily out of sync.
What do you think about removing the description from the json schema files and instead explicitly add a description section to the docs to make it more user friendly?

@roncohen
Copy link
Contributor

I think this issue meant to ask for a couple of paragraphs that explains the general data model in the big picture and how the different document types are related. E.g. what is a span? What does a span represent? How does it relate to transactions? etc.

People can then go into details in the field descriptions that we already have.

@simitt simitt self-assigned this Jan 25, 2018
simitt added a commit to simitt/apm-server that referenced this issue Jan 25, 2018
Define transaction, span and error and restructure documentation.
closes elastic#297
simitt added a commit to simitt/apm-server that referenced this issue Jan 26, 2018
Define transaction, span and error and restructure documentation.
closes elastic#297
simitt added a commit to simitt/apm-server that referenced this issue Jan 26, 2018
Define transaction, span and error and restructure documentation.
closes elastic#297
simitt added a commit to simitt/apm-server that referenced this issue Feb 1, 2018
Define transaction, span and error and restructure documentation.
closes elastic#297
simitt added a commit that referenced this issue Feb 1, 2018
Define transaction, span and error and restructure documentation.
closes #297
simitt added a commit to simitt/apm-server that referenced this issue Feb 1, 2018
Define transaction, span and error and restructure documentation.
closes elastic#297
simitt added a commit to simitt/apm-server that referenced this issue Feb 1, 2018
Define transaction, span and error and restructure documentation.
closes elastic#297
simitt added a commit that referenced this issue Feb 1, 2018
Define transaction, span and error and restructure documentation.
closes #297
simitt added a commit that referenced this issue Feb 1, 2018
Define transaction, span and error and restructure documentation.
closes #297
jalvz pushed a commit to jalvz/apm-server that referenced this issue Feb 1, 2018
Define transaction, span and error and restructure documentation.
closes elastic#297
jalvz pushed a commit to jalvz/apm-server that referenced this issue Feb 1, 2018
Define transaction, span and error and restructure documentation.
closes elastic#297
jalvz pushed a commit to jalvz/apm-server that referenced this issue Feb 1, 2018
Define transaction, span and error and restructure documentation.
closes elastic#297
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants