1
0
mirror of https://github.com/open-telemetry/opentelemetry-go.git synced 2025-11-27 22:49:15 +02:00

OS and Process resource detectors (#1788)

* WIP: OS and Process resource detectors

* Completed documentation headers

* Added empty test files for OS and Process resource functions

* Split long line

* Added resource.WithOS function test

* Added resource.WithProcess* functions tests

* Renamed osDetector and WithOS function to better reflect they only add the os.type attribute

* Updated changelog

* WIP: possible use of wrappers for getting attribute values

* Refined implementation of wrapper functions providing os/runtime/user information

* Added PR number to new changelog entries

Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>

* Fix wrong function name in documentation header

Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>

* Fixed wording in WithProcessOwner documentation header

Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>

* Updated osTypeDetector

* Replaced ToUpper with ToLower to match the current convention.
* Used runtimeOS provider to get the OS name.

* Adapted WithOSType test to mock runtime providers

Co-authored-by: Tyler Yahn <MrAlias@users.noreply.github.com>
This commit is contained in:
Nelson Ghezzi
2021-04-23 15:28:13 +00:00
committed by GitHub
parent 7374d67961
commit aa66fe75e4
7 changed files with 694 additions and 0 deletions

View File

@@ -0,0 +1,302 @@
// 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
//
// http://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.
package resource_test
import (
"context"
"fmt"
"os"
"os/user"
"runtime"
"testing"
"github.com/stretchr/testify/require"
"go.opentelemetry.io/otel/sdk/resource"
)
var (
fakePID = 123
fakeExecutablePath = "/fake/path/mock"
fakeCommandArgs = []string{"mock", "-t", "30"}
fakeOwner = "gopher"
fakeRuntimeName = "gcmock"
fakeRuntimeVersion = "go1.2.3"
fakeRuntimeOS = "linux"
fakeRuntimeArch = "amd64"
)
var (
fakeExecutableName = "mock"
fakeRuntimeDescription = "go version go1.2.3 linux/amd64"
)
var (
fakePidProvider = func() int { return fakePID }
fakeExecutablePathProvider = func() (string, error) { return fakeExecutablePath, nil }
fakeCommandArgsProvider = func() []string { return fakeCommandArgs }
fakeOwnerProvider = func() (*user.User, error) { return &user.User{Username: fakeOwner}, nil }
fakeRuntimeNameProvider = func() string { return fakeRuntimeName }
fakeRuntimeVersionProvider = func() string { return fakeRuntimeVersion }
fakeRuntimeOSProvider = func() string { return fakeRuntimeOS }
fakeRuntimeArchProvider = func() string { return fakeRuntimeArch }
)
var (
fakeExecutablePathProviderWithError = func() (string, error) {
return "", fmt.Errorf("Unable to get process executable")
}
fakeOwnerProviderWithError = func() (*user.User, error) {
return nil, fmt.Errorf("Unable to get process user")
}
)
func mockProcessAttributesProviders() {
resource.SetOSProviders(
fakePidProvider,
fakeExecutablePathProvider,
fakeCommandArgsProvider,
)
resource.SetRuntimeProviders(
fakeRuntimeNameProvider,
fakeRuntimeVersionProvider,
fakeRuntimeOSProvider,
fakeRuntimeArchProvider,
)
resource.SetUserProviders(
fakeOwnerProvider,
)
}
func mockProcessAttributesProvidersWithErrors() {
resource.SetOSProviders(
fakePidProvider,
fakeExecutablePathProviderWithError,
fakeCommandArgsProvider,
)
resource.SetRuntimeProviders(
fakeRuntimeNameProvider,
fakeRuntimeVersionProvider,
fakeRuntimeOSProvider,
fakeRuntimeArchProvider,
)
resource.SetUserProviders(
fakeOwnerProviderWithError,
)
}
func restoreProcessAttributesProviders() {
resource.SetDefaultOSProviders()
resource.SetDefaultRuntimeProviders()
resource.SetDefaultUserProviders()
}
func TestWithProcessFuncs(t *testing.T) {
mockProcessAttributesProviders()
t.Run("WithPID", testWithProcessPID)
t.Run("WithExecutableName", testWithProcessExecutableName)
t.Run("WithExecutablePath", testWithProcessExecutablePath)
t.Run("WithCommandArgs", testWithProcessCommandArgs)
t.Run("WithOwner", testWithProcessOwner)
t.Run("WithRuntimeName", testWithProcessRuntimeName)
t.Run("WithRuntimeVersion", testWithProcessRuntimeVersion)
t.Run("WithRuntimeDescription", testWithProcessRuntimeDescription)
t.Run("WithProcess", testWithProcess)
restoreProcessAttributesProviders()
}
func TestWithProcessFuncsErrors(t *testing.T) {
mockProcessAttributesProvidersWithErrors()
t.Run("WithPID", testWithProcessExecutablePathError)
t.Run("WithExecutableName", testWithProcessOwnerError)
restoreProcessAttributesProviders()
}
func TestCommandArgs(t *testing.T) {
require.EqualValues(t, os.Args, resource.CommandArgs())
}
func TestRuntimeName(t *testing.T) {
require.EqualValues(t, runtime.Compiler, resource.RuntimeName())
}
func TestRuntimeOS(t *testing.T) {
require.EqualValues(t, runtime.GOOS, resource.RuntimeOS())
}
func TestRuntimeArch(t *testing.T) {
require.EqualValues(t, runtime.GOARCH, resource.RuntimeArch())
}
func testWithProcessPID(t *testing.T) {
ctx := context.Background()
res, err := resource.New(ctx,
resource.WithoutBuiltin(),
resource.WithProcessPID(),
)
require.NoError(t, err)
require.EqualValues(t, map[string]string{
"process.pid": fmt.Sprint(fakePID),
}, toMap(res))
}
func testWithProcessExecutableName(t *testing.T) {
ctx := context.Background()
res, err := resource.New(ctx,
resource.WithoutBuiltin(),
resource.WithProcessExecutableName(),
)
require.NoError(t, err)
require.EqualValues(t, map[string]string{
"process.executable.name": fakeExecutableName,
}, toMap(res))
}
func testWithProcessExecutablePath(t *testing.T) {
ctx := context.Background()
res, err := resource.New(ctx,
resource.WithoutBuiltin(),
resource.WithProcessExecutablePath(),
)
require.NoError(t, err)
require.EqualValues(t, map[string]string{
"process.executable.path": fakeExecutablePath,
}, toMap(res))
}
func testWithProcessCommandArgs(t *testing.T) {
ctx := context.Background()
res, err := resource.New(ctx,
resource.WithoutBuiltin(),
resource.WithProcessCommandArgs(),
)
require.NoError(t, err)
require.EqualValues(t, map[string]string{
"process.command_args": fmt.Sprint(fakeCommandArgs),
}, toMap(res))
}
func testWithProcessOwner(t *testing.T) {
ctx := context.Background()
res, err := resource.New(ctx,
resource.WithoutBuiltin(),
resource.WithProcessOwner(),
)
require.NoError(t, err)
require.EqualValues(t, map[string]string{
"process.owner": fakeOwner,
}, toMap(res))
}
func testWithProcessRuntimeName(t *testing.T) {
ctx := context.Background()
res, err := resource.New(ctx,
resource.WithoutBuiltin(),
resource.WithProcessRuntimeName(),
)
require.NoError(t, err)
require.EqualValues(t, map[string]string{
"process.runtime.name": fakeRuntimeName,
}, toMap(res))
}
func testWithProcessRuntimeVersion(t *testing.T) {
ctx := context.Background()
res, err := resource.New(ctx,
resource.WithoutBuiltin(),
resource.WithProcessRuntimeVersion(),
)
require.NoError(t, err)
require.EqualValues(t, map[string]string{
"process.runtime.version": fakeRuntimeVersion,
}, toMap(res))
}
func testWithProcessRuntimeDescription(t *testing.T) {
ctx := context.Background()
res, err := resource.New(ctx,
resource.WithoutBuiltin(),
resource.WithProcessRuntimeDescription(),
)
require.NoError(t, err)
require.EqualValues(t, map[string]string{
"process.runtime.description": fakeRuntimeDescription,
}, toMap(res))
}
func testWithProcess(t *testing.T) {
ctx := context.Background()
res, err := resource.New(ctx,
resource.WithoutBuiltin(),
resource.WithProcess(),
)
require.NoError(t, err)
require.EqualValues(t, map[string]string{
"process.pid": fmt.Sprint(fakePID),
"process.executable.name": fakeExecutableName,
"process.executable.path": fakeExecutablePath,
"process.command_args": fmt.Sprint(fakeCommandArgs),
"process.owner": fakeOwner,
"process.runtime.name": fakeRuntimeName,
"process.runtime.version": fakeRuntimeVersion,
"process.runtime.description": fakeRuntimeDescription,
}, toMap(res))
}
func testWithProcessExecutablePathError(t *testing.T) {
ctx := context.Background()
res, err := resource.New(ctx,
resource.WithoutBuiltin(),
resource.WithProcessExecutablePath(),
)
require.Error(t, err)
require.EqualValues(t, map[string]string{}, toMap(res))
}
func testWithProcessOwnerError(t *testing.T) {
ctx := context.Background()
res, err := resource.New(ctx,
resource.WithoutBuiltin(),
resource.WithProcessOwner(),
)
require.Error(t, err)
require.EqualValues(t, map[string]string{}, toMap(res))
}