-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #737 from iRevive/sdk-common/process-detector
sdk-common: add `ProcessDetector`
- Loading branch information
Showing
13 changed files
with
365 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
60 changes: 60 additions & 0 deletions
60
sdk/common/js/src/main/scala/org/typelevel/otel4s/sdk/resource/ProcessDetectorPlatform.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| /* | ||
| * Copyright 2023 Typelevel | ||
| * | ||
| * 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 org.typelevel.otel4s.sdk.resource | ||
|
|
||
| import cats.effect.Sync | ||
| import org.typelevel.otel4s.Attributes | ||
| import org.typelevel.otel4s.sdk.TelemetryResource | ||
| import org.typelevel.otel4s.semconv.SchemaUrls | ||
|
|
||
| import scala.util.Try | ||
|
|
||
| private[resource] trait ProcessDetectorPlatform { self: ProcessDetector.type => | ||
|
|
||
| def apply[F[_]: Sync]: TelemetryResourceDetector[F] = | ||
| new Detector[F] | ||
|
|
||
| private class Detector[F[_]: Sync] extends TelemetryResourceDetector[F] { | ||
| def name: String = Const.Name | ||
|
|
||
| def detect: F[Option[TelemetryResource]] = Sync[F].delay { | ||
| val argv = Process.argv.toList | ||
|
|
||
| val command = | ||
| if (argv.length > 1) Attributes(Keys.Command(Process.argv(1))) | ||
| else Attributes.empty | ||
|
|
||
| val owner = | ||
| Try( | ||
| Attributes(Keys.Owner(OS.userInfo().username)) | ||
| ).getOrElse(Attributes.empty) | ||
|
|
||
| val args = | ||
| argv.headOption.toSeq ++ Process.execArgv ++ argv.drop(1) | ||
|
|
||
| val attributes = Attributes( | ||
| Keys.Pid(Process.pid.toLong), | ||
| Keys.ExecutableName(Process.title), | ||
| Keys.ExecutablePath(Process.execPath), | ||
| Keys.CommandArgs(args) | ||
| ) ++ command ++ owner | ||
|
|
||
| Some(TelemetryResource(attributes, Some(SchemaUrls.Current))) | ||
| } | ||
| } | ||
|
|
||
| } |
111 changes: 111 additions & 0 deletions
111
...common/jvm/src/main/scala/org/typelevel/otel4s/sdk/resource/ProcessDetectorPlatform.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| /* | ||
| * Copyright 2023 Typelevel | ||
| * | ||
| * 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 org.typelevel.otel4s.sdk.resource | ||
|
|
||
| import cats.effect.Sync | ||
| import cats.syntax.flatMap._ | ||
| import cats.syntax.functor._ | ||
| import org.typelevel.otel4s.Attributes | ||
| import org.typelevel.otel4s.sdk.TelemetryResource | ||
| import org.typelevel.otel4s.semconv.SchemaUrls | ||
|
|
||
| import java.io.File | ||
| import java.lang.management.ManagementFactory | ||
| import java.lang.management.RuntimeMXBean | ||
| import java.util.Locale | ||
| import java.util.regex.Pattern | ||
|
|
||
| private[resource] trait ProcessDetectorPlatform { self: ProcessDetector.type => | ||
|
|
||
| private val JarFilePattern = | ||
| Pattern.compile("^\\S+\\.(jar|war)", Pattern.CASE_INSENSITIVE) | ||
|
|
||
| def apply[F[_]: Sync]: TelemetryResourceDetector[F] = | ||
| new Detector[F] | ||
|
|
||
| private class Detector[F[_]: Sync] extends TelemetryResourceDetector[F] { | ||
| def name: String = Const.Name | ||
|
|
||
| def detect: F[Option[TelemetryResource]] = | ||
| for { | ||
| runtime <- Sync[F].delay(ManagementFactory.getRuntimeMXBean) | ||
| javaHomeOpt <- Sync[F].delay(sys.props.get("java.home")) | ||
| osNameOpt <- Sync[F].delay(sys.props.get("os.name")) | ||
| javaCommandOpt <- Sync[F].delay(sys.props.get("sun.java.command")) | ||
| } yield { | ||
| val builder = Attributes.newBuilder | ||
|
|
||
| getPid(runtime).foreach(pid => builder.addOne(Keys.Pid(pid))) | ||
|
|
||
| javaHomeOpt.foreach { javaHome => | ||
| val exePath = executablePath(javaHome, osNameOpt) | ||
| val cmdLine = exePath + commandLineArgs(runtime, javaCommandOpt) | ||
|
|
||
| builder.addOne(Keys.ExecutablePath(exePath)) | ||
| builder.addOne(Keys.CommandLine(cmdLine)) | ||
| } | ||
|
|
||
| Some(TelemetryResource(builder.result(), Some(SchemaUrls.Current))) | ||
| } | ||
|
|
||
| private def getPid(runtime: RuntimeMXBean): Option[Long] = | ||
| runtime.getName.split("@").headOption.flatMap(_.toLongOption) | ||
|
|
||
| private def executablePath( | ||
| javaHome: String, | ||
| osName: Option[String] | ||
| ): String = { | ||
| val executablePath = new StringBuilder(javaHome) | ||
| executablePath | ||
| .append(File.separatorChar) | ||
| .append("bin") | ||
| .append(File.separatorChar) | ||
| .append("java") | ||
|
|
||
| if (osName.exists(_.toLowerCase(Locale.ROOT).startsWith("windows"))) | ||
| executablePath.append(".exe") | ||
|
|
||
| executablePath.result() | ||
| } | ||
|
|
||
| private def commandLineArgs( | ||
| runtime: RuntimeMXBean, | ||
| javaCommandOpt: Option[String] | ||
| ): String = { | ||
| val commandLine = new StringBuilder() | ||
|
|
||
| // VM args: -Dfile.encoding=UTF-8, -Xms2000m, -Xmx2000m, etc | ||
| runtime.getInputArguments.forEach { arg => | ||
| commandLine.append(' ').append(arg) | ||
| () | ||
| } | ||
|
|
||
| // general args, e.g.: org.ClassName param1 param2 | ||
| javaCommandOpt.foreach { javaCommand => | ||
| // '-jar' is missing when launching a jar directly, add it if needed | ||
| if (JarFilePattern.matcher(javaCommand).matches()) | ||
| commandLine.append(" -jar") | ||
|
|
||
| commandLine.append(' ').append(javaCommand) | ||
| () | ||
| } | ||
|
|
||
| commandLine.result() | ||
| } | ||
| } | ||
|
|
||
| } |
43 changes: 43 additions & 0 deletions
43
...mon/native/src/main/scala/org/typelevel/otel4s/sdk/resource/ProcessDetectorPlatform.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| /* | ||
| * Copyright 2023 Typelevel | ||
| * | ||
| * 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 org.typelevel.otel4s.sdk.resource | ||
|
|
||
| import cats.effect.Sync | ||
| import org.typelevel.otel4s.Attributes | ||
| import org.typelevel.otel4s.sdk.TelemetryResource | ||
| import org.typelevel.otel4s.semconv.SchemaUrls | ||
|
|
||
| import scala.scalanative.posix.unistd._ | ||
|
|
||
| private[resource] trait ProcessDetectorPlatform { self: ProcessDetector.type => | ||
|
|
||
| def apply[F[_]: Sync]: TelemetryResourceDetector[F] = | ||
| new Detector[F] | ||
|
|
||
| private class Detector[F[_]: Sync] extends TelemetryResourceDetector[F] { | ||
| def name: String = Const.Name | ||
|
|
||
| def detect: F[Option[TelemetryResource]] = Sync[F].delay { | ||
| val attributes = Attributes( | ||
| Keys.Pid(getpid().longValue) | ||
| ) | ||
|
|
||
| Some(TelemetryResource(attributes, Some(SchemaUrls.Current))) | ||
| } | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
56 changes: 56 additions & 0 deletions
56
sdk/common/shared/src/main/scala/org/typelevel/otel4s/sdk/resource/ProcessDetector.scala
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| /* | ||
| * Copyright 2023 Typelevel | ||
| * | ||
| * 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 org.typelevel.otel4s.sdk.resource | ||
|
|
||
| import org.typelevel.otel4s.AttributeKey | ||
|
|
||
| /** Detects process-specific parameters such as executable name, executable | ||
| * path, PID, and so on. | ||
| * | ||
| * @see | ||
| * [[https://opentelemetry.io/docs/specs/semconv/resource/process/]] | ||
| */ | ||
| object ProcessDetector extends ProcessDetectorPlatform { | ||
|
|
||
| private[sdk] object Const { | ||
| val Name = "process" | ||
| } | ||
|
|
||
| private[resource] object Keys { | ||
| val Command: AttributeKey[String] = | ||
| AttributeKey("process.command") | ||
|
|
||
| val CommandArgs: AttributeKey[Seq[String]] = | ||
| AttributeKey("process.command_args") | ||
|
|
||
| val CommandLine: AttributeKey[String] = | ||
| AttributeKey("process.command_line") | ||
|
|
||
| val ExecutableName: AttributeKey[String] = | ||
| AttributeKey("process.executable.name") | ||
|
|
||
| val ExecutablePath: AttributeKey[String] = | ||
| AttributeKey("process.executable.path") | ||
|
|
||
| val Pid: AttributeKey[Long] = | ||
| AttributeKey("process.pid") | ||
|
|
||
| val Owner: AttributeKey[String] = | ||
| AttributeKey("process.owner") | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.