open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarify function name conventions (#888)

This commit is contained in:
Tigran Najaryan 2020-08-27 19:28:30 -04:00 committed by GitHub
parent 521dfd99aa
commit a5f6991ebe
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
specification/trace/semantic_conventions/faas.md
View File

@ -29,6 +29,21 @@ If Spans following this convention are produced, a Resource of type `faas` MUST
| `faas.execution` | String containing the execution id of the function. E.g. `af9d5aa4-a685-4c5f-a22b-444f80b3cc28` | No |
| `faas.coldstart` | A boolean indicating that the serverless function is executed for the first time (aka cold start). | No |
### Function Name
There are 2 locations where the function's name can be recorded: the span name and the
[`faas.name` Resource attribute](../../resource/semantic_conventions/faas.md#function-as-a-service).
It is guaranteed that if `faas.name` attribute is present it will contain the
function name, since it is defined in the semantic convention strictly for that
purpose. It is also highly likely that Span name will contain the function name
(e.g. for Span displaying purposes), but it is not guaranteed (since it is a
weaker "SHOULD" requirement). Consumers that needs such guarantee can use
`faas.name` attribute as the source. If `faas.name` is not present but other
`faas` attributes are present (indicating that the data is coming from a
function) then consumers may use the span name as the fallback source for the
function's name.
### Difference between execution and instance
For performance reasons (e.g. [AWS lambda], or [Azure functions]), FaaS providers allocate an execution environment for a single instance of a function that is used to serve multiple requests.