Add yaml for FaaS trace attributes #1054
Conversation
arminru
added
area:semantic-conventions
There was a problem hiding this comment.
I think we are overusing the numbered footnotes a bit. I think we can keep most of the text in the Description field. Use footnotes if the Description is too large and becomes a wall of text or when it is needed to describe a list of possible values as a separate table (I like that).
| | `datasource` | A response to some data source operation such as a database or filesystem read/write. | | ||
| | `http` | To provide an answer to an inbound HTTP request | | ||
| | `pubsub` | A function is set to be executed when messages are sent to a messaging system. | | ||
| | `timer` | A function is scheduled to be executed regularly. | | ||
| | `other` | If none of the other applies | |
There was a problem hiding this comment.
Did we have these descriptions in faas.md previously or these are new in this PR?
There was a problem hiding this comment.
The descriptions are new but only taken over and paraphrased from the first sentence of the respective section for each trigger type.
I agree that the current footnote/description split in the markdown looks often bad. But I think semantically the split is OK in the YAML. The |
|
@tigrannajaryan could you please have another look? I reduced the footnotes as you suggested. However, I left the ones for the |
semantic_conventions/trace/faas.yaml
Outdated
| - id: faas_span | ||
| prefix: faas | ||
| brief: > | ||
| This document defines how to describe an instance of a function that |
There was a problem hiding this comment.
IMHO we should not talk about "this document" in the YAML, as it may become javadoc or something else.
There was a problem hiding this comment.
@thisthat I'm ok to merge. If you want to change the "This document" comment, lmk
thisthat
force-pushed
the
yaml-trace-faas
branch
from
8c5a402
to
1154929
Compare
|
@SergeyKanzhelev I have addressed the comment :) |
Co-authored-by: Christian Neumüller <[email protected]>
Co-authored-by: Christian Neumüller <[email protected]> Co-authored-by: Armin Ruech <[email protected]>
Fixes #547
Changes
Editorial change.
This PR introduces the YAML definitions of FaaS span attributes.