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

semantic conventions for operating system #1407

Merged
merged 5 commits into from
Aug 10, 2020
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,4 @@ export * from './general';
export * from './rpc';
export * from './http';
export * from './database';
export * from './os';
62 changes: 62 additions & 0 deletions packages/opentelemetry-semantic-conventions/src/trace/os.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
/*
* Copyright The OpenTelemetry Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

/**
* The operating system (OS) on which the process represented by this resource is running.
*
* In case of virtualized environments, this is the operating system as it
* is observed by the process, i.e., the virtualized guest rather than the
* underlying host.
obecny marked this conversation as resolved.
Show resolved Hide resolved
*/
export const OperatingSystem = {
/**
* The operating system type.
* This should be set to one of {@link OperatingSystemValues}
* E.g., "WINDOWS"
*
* @remarks
* Required.
*/
TYPE: 'os.type',
/**
* Human readable (not intended to be parsed) OS version information.
* E.g., "Microsoft Windows [Version 10.0.18363.778]"
*
* @remarks
* Required if applicable.
*/
DESCRIPTION: 'os.description',
};

/**
* {@link OperatingSystem.TYPE} SHOULD be set to one of the values
* listed below.
* If none of the listed values apply, a custom value best describing
* the family the operating system belongs to CAN be used.
*/
export const OperatingSystemValues = {
WINDOWS: 'WINDOWS',
LINUX: 'LINUX',
DARWIN: 'DARWIN',
FREEBSD: 'FREEBSD',
NETBSD: 'NETBSD',
OPENBSD: 'OPENBSD',
DRAGONFLYBSD: 'DRAGONFLYBSD',
HPUX: 'HPUX',
AIX: 'AIX',
SOLARIS: 'SOLARIS',
ZOS: 'ZOS',
};