|
| 1 | +package frameworks |
| 2 | + |
| 3 | +import ( |
| 4 | + "fmt" |
| 5 | + "path/filepath" |
| 6 | + |
| 7 | + "github.com/cloudfoundry/libbuildpack" |
| 8 | +) |
| 9 | + |
| 10 | +// OpenTelemetryJavaagentFramework implements OpenTelemetry instrumentation support |
| 11 | +type OpenTelemetryJavaagentFramework struct { |
| 12 | + context *Context |
| 13 | +} |
| 14 | + |
| 15 | +// NewOpenTelemetryJavaagentFramework creates a new OpenTelemetry Javaagent framework instance |
| 16 | +func NewOpenTelemetryJavaagentFramework(ctx *Context) *OpenTelemetryJavaagentFramework { |
| 17 | + return &OpenTelemetryJavaagentFramework{context: ctx} |
| 18 | +} |
| 19 | + |
| 20 | +// Detect checks if OpenTelemetry should be included |
| 21 | +func (o *OpenTelemetryJavaagentFramework) Detect() (string, error) { |
| 22 | + // Check for OpenTelemetry service binding |
| 23 | + vcapServices, err := GetVCAPServices() |
| 24 | + if err != nil { |
| 25 | + o.context.Log.Warning("Failed to parse VCAP_SERVICES: %s", err.Error()) |
| 26 | + return "", nil |
| 27 | + } |
| 28 | + |
| 29 | + // OpenTelemetry can be bound as: |
| 30 | + // - "otel-collector" service (required by Ruby implementation) |
| 31 | + // - Services with "otel" or "opentelemetry" tag |
| 32 | + // - User-provided services with "otel-collector" in the name (Docker platform) |
| 33 | + if vcapServices.HasService("otel-collector") || |
| 34 | + vcapServices.HasService("opentelemetry") || |
| 35 | + vcapServices.HasTag("otel") || |
| 36 | + vcapServices.HasTag("otel-collector") || |
| 37 | + vcapServices.HasTag("opentelemetry") || |
| 38 | + vcapServices.HasServiceByNamePattern("otel-collector") || |
| 39 | + vcapServices.HasServiceByNamePattern("otel") { |
| 40 | + o.context.Log.Info("OpenTelemetry service detected!") |
| 41 | + return "OpenTelemetry Javaagent", nil |
| 42 | + } |
| 43 | + |
| 44 | + o.context.Log.Debug("OpenTelemetry not detected") |
| 45 | + return "", nil |
| 46 | +} |
| 47 | + |
| 48 | +// Supply installs the OpenTelemetry Javaagent |
| 49 | +func (o *OpenTelemetryJavaagentFramework) Supply() error { |
| 50 | + o.context.Log.BeginStep("Installing OpenTelemetry Javaagent") |
| 51 | + |
| 52 | + // Get OpenTelemetry agent dependency from manifest |
| 53 | + dep, err := o.context.Manifest.DefaultVersion("open-telemetry-javaagent") |
| 54 | + if err != nil { |
| 55 | + o.context.Log.Warning("Unable to determine OpenTelemetry version, using default") |
| 56 | + dep = libbuildpack.Dependency{ |
| 57 | + Name: "open-telemetry-javaagent", |
| 58 | + Version: "2.10.0", // Fallback version |
| 59 | + } |
| 60 | + } |
| 61 | + |
| 62 | + // Install OpenTelemetry agent JAR |
| 63 | + agentDir := filepath.Join(o.context.Stager.DepDir(), "open_telemetry_javaagent") |
| 64 | + if err := o.context.Installer.InstallDependency(dep, agentDir); err != nil { |
| 65 | + return fmt.Errorf("failed to install OpenTelemetry agent: %w", err) |
| 66 | + } |
| 67 | + |
| 68 | + o.context.Log.Info("Installed OpenTelemetry Javaagent version %s", dep.Version) |
| 69 | + return nil |
| 70 | +} |
| 71 | + |
| 72 | +// Finalize performs final OpenTelemetry configuration |
| 73 | +func (o *OpenTelemetryJavaagentFramework) Finalize() error { |
| 74 | + o.context.Log.BeginStep("Configuring OpenTelemetry Javaagent") |
| 75 | + |
| 76 | + // Find the OpenTelemetry agent JAR |
| 77 | + agentDir := filepath.Join(o.context.Stager.DepDir(), "open_telemetry_javaagent") |
| 78 | + agentJar := filepath.Join(agentDir, "opentelemetry-javaagent.jar") |
| 79 | + |
| 80 | + // Add javaagent to JAVA_OPTS |
| 81 | + javaOpts := fmt.Sprintf("-javaagent:%s", agentJar) |
| 82 | + |
| 83 | + // Get OpenTelemetry configuration from service binding |
| 84 | + vcapServices, _ := GetVCAPServices() |
| 85 | + |
| 86 | + // Try to find service by various patterns |
| 87 | + var service *VCAPService |
| 88 | + if vcapServices.HasService("otel-collector") { |
| 89 | + service = vcapServices.GetService("otel-collector") |
| 90 | + } |
| 91 | + if service == nil && vcapServices.HasService("opentelemetry") { |
| 92 | + service = vcapServices.GetService("opentelemetry") |
| 93 | + } |
| 94 | + if service == nil { |
| 95 | + service = vcapServices.GetServiceByNamePattern("otel-collector") |
| 96 | + } |
| 97 | + if service == nil { |
| 98 | + service = vcapServices.GetServiceByNamePattern("otel") |
| 99 | + } |
| 100 | + |
| 101 | + // Add all otel.* credentials from the service bind as JVM system properties |
| 102 | + if service != nil && service.Credentials != nil { |
| 103 | + for key, value := range service.Credentials { |
| 104 | + // Only add properties that start with "otel." |
| 105 | + if len(key) >= 5 && key[:5] == "otel." { |
| 106 | + javaOpts += fmt.Sprintf(" -D%s=%v", key, value) |
| 107 | + } |
| 108 | + } |
| 109 | + |
| 110 | + // Set otel.service.name to the application name if not specified in credentials |
| 111 | + if _, hasServiceName := service.Credentials["otel.service.name"]; !hasServiceName { |
| 112 | + // Use the build directory name as the application name |
| 113 | + appName := filepath.Base(o.context.Stager.BuildDir()) |
| 114 | + javaOpts += fmt.Sprintf(" -Dotel.service.name=%s", appName) |
| 115 | + } |
| 116 | + } |
| 117 | + |
| 118 | + // Write JAVA_OPTS to environment |
| 119 | + if err := o.context.Stager.WriteEnvFile("JAVA_OPTS", javaOpts); err != nil { |
| 120 | + return fmt.Errorf("failed to set JAVA_OPTS for OpenTelemetry: %w", err) |
| 121 | + } |
| 122 | + |
| 123 | + o.context.Log.Info("Configured OpenTelemetry Javaagent") |
| 124 | + return nil |
| 125 | +} |
0 commit comments