add environment attribute: Deployment Environment #606

ecourreges-orange · 2020-05-14T14:18:00Z

Following @arminru 's advice:

I can't find the Deployement Environment concept in resource semantic conventions so I added it.

I called the attribute environment without any type.

We might have a bit of a naming conflict for the sections "Deployment Service" and "Environment -> Deployment Environment"

Thanks for your comments.

Fixes #593

dyladan · 2020-05-14T14:20:57Z

specification/resource/semantic_conventions/README.md

+
+| Attribute  | Description  | Example  | Required? |
+|---|---|---|---|
+| environment | Name of the [deployment environment](https://en.wikipedia.org/wiki/Deployment_environment)  | `staging` , `production` | Yes |


I think a less overloaded term for this might be "stage". Environment already means too many things.

stage sounds good! Environment could really be anything from the OS, cloud provider to the env variables and much more.

What about just deployment_environment? You might also have different production environments like "free", "vip", so I'd say using environments for staged deployments is just one use case.

Or, if my understanding of the term is wrong, the linked Wikipedia entry suggests the synonym tier.

The term tier is already preoccupied by multi-tier architectures ([frontend]<->[application/businesslogic]<->[database]) but I agree that we should consider the possibility of multiple deployments in the same stage of maturity.

deployment_environment sounds good to me. I agree that stage is just one use case for multi-environment.

What about a deployment category with deployment.environment?
I am also looking to add something like deployment.datacenter or hosting.datacenter
For those of us not on a cloud deployment, calling my datacenter cloud.region is slightly abusive

arminru · 2020-05-14T14:28:29Z

I called the attribute environment without any type.

I don't think it's beneficial to force users to map their internal names to a rigid set of pre-defined values as this would just confuse those looking at the monitoring system, so allowing arbitrary strings should indeed be just fine here.

ecourreges-orange · 2020-05-14T14:31:23Z

I called the attribute environment without any type.

I don't think it's beneficial to force users to map their internal names to a rigid set of pre-defined values as this would just confuse those looking at the monitoring system, so allowing arbitrary strings should indeed be just fine here.

Sorry, I meant no type as in cloud or k8s or other types displayed on the same page, but if I would have given it a type, it would have been deployment with an attribute such as deployment.environment or deployment.tier

arminru · 2020-05-14T14:38:03Z

I called the attribute environment without any type.

I don't think it's beneficial to force users to map their internal names to a rigid set of pre-defined values as this would just confuse those looking at the monitoring system, so allowing arbitrary strings should indeed be just fine here.

Sorry, I meant no type as in cloud or k8s or other types displayed on the same page, but if I would have given it a type, it would have been deployment with an attribute such as deployment.environment or deployment.tier

Ah now I get you :-)
It could make sense to introduce deployment as its own type. Would there be any additional deployment-related attributes you could think of that would be of value?

dyladan · 2020-05-14T14:38:40Z

I called the attribute environment without any type.

I don't think it's beneficial to force users to map their internal names to a rigid set of pre-defined values as this would just confuse those looking at the monitoring system, so allowing arbitrary strings should indeed be just fine here.

Sorry, I meant no type as in cloud or k8s or other types displayed on the same page, but if I would have given it a type, it would have been deployment with an attribute such as deployment.environment or deployment.tier

Ah now I get you :-)
It could make sense to introduce deployment as its own type. Would there be any additional deployment-related attributes you could think of that would be of value?

Might I suggest.... deployment.stage? 😉

specification/resource/semantic_conventions/README.md

bogdandrutu · 2020-08-04T14:55:43Z

The CLA not does not want to trigger the check can you reopen this PR?

ecourreges-orange · 2020-08-05T13:07:33Z

EasyCLA is successful now.
I decided to merge Deployment Service into Environment, so that deployment service and deployment.environment are close to each other, avoiding any possible confusion for a first time reader.

specification/resource/semantic_conventions/README.md

Oberon00 · 2020-08-10T12:54:59Z

I think this can be merged @open-telemetry/technical-committee EDIT: Sorry, I see all approvals are only from Dynatrace so not ready to merge after all.

@tigrannajaryan if you are OK with this PR now, you could approve.

carlosalberto · 2020-08-13T14:08:03Z

Looks good to go! Let's wait 1 day and LGTM.

tigrannajaryan

LGTM

specification/resource/semantic_conventions/README.md

specification/resource/semantic_conventions/deployment.md

Merge "Deployment Service / Kubernetes" section into "Environment" section for consistency Create deployment_environment.md for new deployment.environment attribute Signed-off-by: CI-Bot for Emmanuel Courreges <emmanuel.courreges@orange.com>

bogdandrutu · 2020-08-13T20:50:27Z

specification/resource/semantic_conventions/README.md


 - [Operating System](./os.md)
 - [Cloud](./cloud.md)
+- Deployment:
+  - [Environment](./deployment_environment.md)


s/Environment/ProductionEnvironment?

Or maybe "Environment Stage"?

"Environment" is a bit too generic I feel like.

Please address the feedback here (either way) @ecourreges-orange ;)

carlosalberto · 2020-08-17T21:13:11Z

@ecourreges-orange Sorry for the delayed feedback - once you address a latest detail regarding the (too generic) usage of "Envirionment", we are totally ready to merge.

bogdandrutu · 2020-08-19T21:58:35Z

@ecourreges-orange ping :)

carlosalberto · 2020-08-21T14:00:53Z

Merging, will follow up with @bogdandrutu's suggestion.

arminru · 2020-08-21T14:18:19Z

Merging, will follow up with @bogdandrutu's suggestion.

@carlosalberto Thanks! Please also add the new attribute to the changelog while you're at it.

Add a constant for the recently introduced deployment environment resource attribute: open-telemetry/opentelemetry-specification#606

ecourreges-orange requested review from arminru, bogdandrutu, c24t, carlosalberto, iredelmeier, jmacd, reyang, SergeyKanzhelev, tedsuo, tigrannajaryan and yurishkuro as code owners May 14, 2020 14:18

dyladan reviewed May 14, 2020

View reviewed changes

arminru reviewed May 14, 2020

View reviewed changes

specification/resource/semantic_conventions/README.md Outdated Show resolved Hide resolved

arminru added area:semantic-conventions Related to semantic conventions spec:resource Related to the specification/resource directory labels May 14, 2020

arminru linked an issue May 14, 2020 that may be closed by this pull request

Server hostname, datacenter, region, availability zone missing in general conventions area:semantic-conventions #593

Closed

reyang added the release:after-ga Not required before GA release, and not going to work on before GA label Jul 6, 2020

arminru mentioned this pull request Jul 31, 2020

Convention: environment attribute (production, staging...) #752

Closed

anuraaga mentioned this pull request Jul 31, 2020

Clarify how to make progress on a PR #745

Merged

bogdandrutu closed this Aug 4, 2020

bogdandrutu reopened this Aug 4, 2020

ecourreges-orange closed this Aug 5, 2020

ecourreges-orange force-pushed the master branch from 156b14e to b4e327c Compare August 5, 2020 12:36

ecourreges-orange reopened this Aug 5, 2020

arminru linked an issue Aug 5, 2020 that may be closed by this pull request

Convention: environment attribute (production, staging...) #752

Closed

ecourreges-orange mentioned this pull request Aug 5, 2020

Server hostname, datacenter, region, availability zone missing in general conventions area:semantic-conventions #593

Closed

Oberon00 approved these changes Aug 7, 2020

View reviewed changes

arminru approved these changes Aug 7, 2020

View reviewed changes

specification/resource/semantic_conventions/README.md Outdated Show resolved Hide resolved

anuraaga approved these changes Aug 7, 2020

View reviewed changes

bogdandrutu assigned carlosalberto Aug 12, 2020

carlosalberto approved these changes Aug 13, 2020

View reviewed changes

tigrannajaryan approved these changes Aug 13, 2020

View reviewed changes

bogdandrutu reviewed Aug 13, 2020

View reviewed changes

specification/resource/semantic_conventions/README.md Outdated Show resolved Hide resolved

specification/resource/semantic_conventions/deployment.md Outdated Show resolved Hide resolved

ecourreges-orange force-pushed the master branch from aced2cc to 09eb79a Compare August 13, 2020 20:25

ecourreges-orange requested review from a team as code owners August 13, 2020 20:25

bogdandrutu reviewed Aug 13, 2020

View reviewed changes

Merge branch 'master' into master

ba44c58

carlosalberto merged commit 376e5f4 into open-telemetry:master Aug 21, 2020

carlosalberto mentioned this pull request Aug 21, 2020

Use Deployment Environment in Resources' README instead of Environment. #851

Merged

axw mentioned this pull request Aug 24, 2020

Add service environment configuration to elastic exporter open-telemetry/opentelemetry-collector-contrib#438

Closed

cyrille-leclerc mentioned this pull request Aug 24, 2020

[RFC] service.environment field elastic/ecs#891

Merged

axw added a commit to axw/opentelemetry-collector that referenced this pull request Aug 31, 2020

translator/conventions: add deployment.environment

8421902

Add a constant for the recently introduced deployment environment resource attribute: open-telemetry/opentelemetry-specification#606

axw mentioned this pull request Aug 31, 2020

translator/conventions: add deployment.environment open-telemetry/opentelemetry-collector#1691

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add environment attribute: Deployment Environment #606

add environment attribute: Deployment Environment #606

ecourreges-orange commented May 14, 2020 •

edited by bogdandrutu

Loading

dyladan May 14, 2020

arminru May 14, 2020

Oberon00 May 14, 2020

Oberon00 May 14, 2020

arminru May 14, 2020

dyladan May 14, 2020

ecourreges-orange May 14, 2020 •

edited

Loading

arminru commented May 14, 2020

ecourreges-orange commented May 14, 2020

arminru commented May 14, 2020

dyladan commented May 14, 2020

bogdandrutu commented Aug 4, 2020

ecourreges-orange commented Aug 5, 2020

Oberon00 commented Aug 10, 2020 •

edited

Loading

carlosalberto commented Aug 13, 2020

tigrannajaryan left a comment

bogdandrutu Aug 13, 2020

carlosalberto Aug 17, 2020

carlosalberto commented Aug 17, 2020

bogdandrutu commented Aug 19, 2020

carlosalberto commented Aug 21, 2020

arminru commented Aug 21, 2020

add environment attribute: Deployment Environment #606

add environment attribute: Deployment Environment #606

Conversation

ecourreges-orange commented May 14, 2020 • edited by bogdandrutu Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ecourreges-orange May 14, 2020 • edited Loading

Choose a reason for hiding this comment

arminru commented May 14, 2020

ecourreges-orange commented May 14, 2020

arminru commented May 14, 2020

dyladan commented May 14, 2020

bogdandrutu commented Aug 4, 2020

ecourreges-orange commented Aug 5, 2020

Oberon00 commented Aug 10, 2020 • edited Loading

carlosalberto commented Aug 13, 2020

tigrannajaryan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

carlosalberto commented Aug 17, 2020

bogdandrutu commented Aug 19, 2020

carlosalberto commented Aug 21, 2020

arminru commented Aug 21, 2020

ecourreges-orange commented May 14, 2020 •

edited by bogdandrutu

Loading

ecourreges-orange May 14, 2020 •

edited

Loading

Oberon00 commented Aug 10, 2020 •

edited

Loading