Skip to content

Remove io.pivotal.cfenv #207

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.

Sign up for GitHub

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

Merged
KarstenSchnitter merged 1 commit into from
May 12, 2025
Merged

Remove io.pivotal.cfenv #207

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
23 changes: 21 additions & 2 deletions cf-java-logging-support-opentelemetry-agent-extension/dependency-reduced-pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,16 @@
<configuration>
<filters>
<filter>
<artifact>io.pivotal.cfenv:java-cfenv</artifact>
<artifact>io.opentelemetry.contrib:opentelemetry-cloudfoundry-resources</artifact>
<includes>
<include>io/pivotal/cfenv/**</include>
<include>io/opentelemetry/contrib/cloudfoundry/resources/CloudFoundryResource.class</include>
</includes>
</filter>
</filters>
<artifactSet>
<excludes>
<exclude>io.opentelemetry</exclude>
<exclude>io.opentelemetry.semconv</exclude>
<exclude>com.fasterxml.jackson.core</exclude>
<exclude>com.squareup.okhttp3</exclude>
<exclude>com.squareup.okio</exclude>
Expand Down Expand Up @@ -70,6 +71,24 @@
<version>1.31.0</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
<version>2.18.2</version>
<scope>compile</scope>
</dependency>
<dependency>
<groupId>uk.org.webcompere</groupId>
<artifactId>system-stubs-junit4</artifactId>
<version>2.1.8</version>
<scope>test</scope>
<exclusions>
<exclusion>
<artifactId>system-stubs-core</artifactId>
<groupId>uk.org.webcompere</groupId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
Expand Down
26 changes: 20 additions & 6 deletions cf-java-logging-support-opentelemetry-agent-extension/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,20 @@
<artifactId>opentelemetry-exporter-otlp</artifactId>
</dependency>
<dependency>
<groupId>io.pivotal.cfenv</groupId>
<artifactId>java-cfenv</artifactId>
<version>2.5.0</version>
<groupId>io.opentelemetry.contrib</groupId>
<artifactId>opentelemetry-cloudfoundry-resources</artifactId>
<version>1.46.0-alpha</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
<version>${jackson-jr.version}</version>
</dependency>
<dependency>
<groupId>uk.org.webcompere</groupId>
<artifactId>system-stubs-junit4</artifactId>
<version>2.1.8</version>
<scope>test</scope>
</dependency>
</dependencies>

Expand All @@ -76,15 +87,18 @@
<configuration>
<filters>
<filter>
<artifact>io.pivotal.cfenv:java-cfenv</artifact>
<artifact>io.opentelemetry.contrib:opentelemetry-cloudfoundry-resources</artifact>
<includes>
<include>io/pivotal/cfenv/**</include>
<include>
io/opentelemetry/contrib/cloudfoundry/resources/CloudFoundryResource.class
</include>
</includes>
</filter>
</filters>
<artifactSet>
<excludes>
<exclude>io.opentelemetry</exclude>
<exclude>io.opentelemetry.semconv</exclude>
<exclude>com.fasterxml.jackson.core</exclude>
<exclude>com.squareup.okhttp3</exclude>
<exclude>com.squareup.okio</exclude>
Expand All @@ -106,4 +120,4 @@
</plugin>
</plugins>
</build>
</project>
</project>
18 changes: 5 additions & 13 deletions ...ain/java/com/sap/hcf/cf/logging/opentelemetry/agent/ext/CloudFoundryResourceProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,16 @@

import com.sap.hcf.cf.logging.opentelemetry.agent.ext.attributes.CloudFoundryResourceCustomizer;
import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
import io.opentelemetry.sdk.autoconfigure.spi.ResourceProvider;
import io.opentelemetry.sdk.resources.Resource;
import io.pivotal.cfenv.core.CfEnv;

public class CloudFoundryResourceProvider implements ResourceProvider {
public class CloudFoundryResourceProvider
extends io.opentelemetry.contrib.cloudfoundry.resources.CloudFoundryResourceProvider {

private final CloudFoundryResourceCustomizer customizer;

public CloudFoundryResourceProvider() {
this(new CfEnv());
}

public CloudFoundryResourceProvider(CfEnv cfEnv) {
this.customizer = new CloudFoundryResourceCustomizer(cfEnv);
}
private final CloudFoundryResourceCustomizer customizer = new CloudFoundryResourceCustomizer();

@Override
public Resource createResource(ConfigProperties configProperties) {
return customizer.apply(null, configProperties);
Resource original = super.createResource(configProperties);
return customizer.apply(original, configProperties);
}
}
5 changes: 1 addition & 4 deletions ...p/hcf/cf/logging/opentelemetry/agent/ext/CloudLoggingConfigurationCustomizerProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,18 @@
import com.sap.hcf.cf.logging.opentelemetry.agent.ext.binding.CloudLoggingBindingPropertiesSupplier;
import io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizer;
import io.opentelemetry.sdk.autoconfigure.spi.AutoConfigurationCustomizerProvider;
import io.pivotal.cfenv.core.CfEnv;

import java.util.logging.Logger;

public class CloudLoggingConfigurationCustomizerProvider implements AutoConfigurationCustomizerProvider {

private static final Logger LOG = Logger.getLogger(CloudLoggingConfigurationCustomizerProvider.class.getName());
private static final String VERSION = "3.8.4";
private static final CfEnv cfEnv = new CfEnv();

@Override
public void customize(AutoConfigurationCustomizer autoConfiguration) {
LOG.info("Initializing SAP BTP Observability extension " + VERSION);
autoConfiguration
.addPropertiesSupplier(new CloudLoggingBindingPropertiesSupplier());
autoConfiguration.addPropertiesSupplier(new CloudLoggingBindingPropertiesSupplier());

// ConfigurableLogRecordExporterProvider
}
Expand Down
104 changes: 73 additions & 31 deletions ...sap/hcf/cf/logging/opentelemetry/agent/ext/attributes/CloudFoundryResourceCustomizer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,36 @@
package com.sap.hcf.cf.logging.opentelemetry.agent.ext.attributes;

import io.opentelemetry.api.common.AttributeKey;
import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
import io.opentelemetry.sdk.resources.Resource;
import io.opentelemetry.sdk.resources.ResourceBuilder;
import io.pivotal.cfenv.core.CfApplication;
import io.pivotal.cfenv.core.CfEnv;

import java.util.Optional;
import java.util.HashMap;
import java.util.Map;
import java.util.function.BiConsumer;
import java.util.function.BiFunction;
import java.util.logging.Logger;

public class CloudFoundryResourceCustomizer implements BiFunction<Resource, ConfigProperties, Resource> {

private static final String OTEL_JAVAAGENT_EXTENSION_SAP_CF_RESOURCE_ENABLED = "otel.javaagent.extension.sap.cf.resource.enabled";
private static final String OTEL_JAVAAGENT_EXTENSION_SAP_CF_RESOURCE_ENABLED =
"otel.javaagent.extension.sap.cf.resource.enabled";

private static final String OTEL_JAVAAGENT_EXTENTION_CF_RESOURCE_FORMAT =
"otel.javaagent.extension.sap.cf.resource.format";
private static final Logger LOG = Logger.getLogger(CloudFoundryResourceCustomizer.class.getName());
private final CfEnv cfEnv;

public CloudFoundryResourceCustomizer(CfEnv cfEnv) {
this.cfEnv = cfEnv;
}
private static final Map<String, String> SAP_CF_RESOURCE_ATTRIBUTES = new HashMap<String, String>() {{
put("cloudfoundry.app.id", "sap.cf.app_id");
put("cloudfoundry.app.instance.id", "sap.cf.instance_id");
put("cloudfoundry.app.name", "sap.cf.app_name");
put("cloudfoundry.org.id", "sap.cf.org_id");
put("cloudfoundry.org.name", "sap.cf.org_name");
put("cloudfoundry.process.id", "sap.cf.process.id");
put("cloudfoundry.process.type", "sap.cf.process.type");
put("cloudfoundry.space.id", "sap.cf.space_id");
put("cloudfoundry.space.name", "sap.cf.space_name");
}};

@Override
public Resource apply(Resource resource, ConfigProperties configProperties) {
Expand All @@ -27,32 +39,62 @@ public Resource apply(Resource resource, ConfigProperties configProperties) {
LOG.config("CF resource attributes are disabled by configuration.");
return Resource.empty();
}
if (!cfEnv.isInCf()) {

if (resource == null || resource.getAttributes().isEmpty()) {
LOG.config("Not running in CF. Cannot obtain CF resource attributes.");
return Resource.empty();
return resource;
}

String format = configProperties.getString(OTEL_JAVAAGENT_EXTENTION_CF_RESOURCE_FORMAT, "SAP");
if (!format.equalsIgnoreCase("SAP")) {
return resource;
}

ResourceBuilder builder = Resource.builder();
resource.getAttributes().asMap().forEach(addAttribute(builder));
String appId = resource.getAttribute(AttributeKey.stringKey("cloudfoundry.app.id"));
builder.put("sap.cf.source_id", appId);
String appName = resource.getAttribute(AttributeKey.stringKey("cloudfoundry.app.name"));
String serviceName = resource.getAttribute(AttributeKey.stringKey("service.name"));
if (serviceName == null) {
builder.put("service.name", appName);
}
CfApplication cfApp = cfEnv.getApp();
ResourceBuilder rb = Resource.builder();
rb.put("service.name", cfApp.getApplicationName());
rb.put("sap.cf.source_id", cfApp.getApplicationId());
rb.put("sap.cf.instance_id", cfApp.getInstanceIndex());
rb.put("sap.cf.app_id", cfApp.getApplicationId());
rb.put("sap.cf.app_name", cfApp.getApplicationName());
rb.put("sap.cf.space_id", cfApp.getSpaceId());
rb.put("sap.cf.space_name", cfApp.getSpaceName());
rb.put("sap.cf.org_id", getString(cfApp, "organization_id"));
rb.put("sap.cf.org_name", getString(cfApp, "organization_name"));
rb.put("sap.cf.process.id", getString(cfApp, "process_id"));
rb.put("sap.cf.process.type", getString(cfApp, "process_type"));
return rb.build();
return builder.build();
}

private BiConsumer<AttributeKey<?>, Object> addAttribute(ResourceBuilder builder) {
return (k, v) -> {
switch (k.getType()) {
case BOOLEAN:
builder.put(rename(k), (boolean) v);
break;
case BOOLEAN_ARRAY:
builder.put(rename(k), (boolean[]) v);
break;
case DOUBLE:
builder.put(rename(k), (double) v);
break;
case DOUBLE_ARRAY:
builder.put(rename(k), (double[]) v);
break;
case LONG:
builder.put(rename(k), (long) v);
break;
case LONG_ARRAY:
builder.put(rename(k), (long[]) v);
break;
case STRING:
builder.put(rename(k), (String) v);
break;
case STRING_ARRAY:
builder.put(rename(k), (String[]) v);
break;
}
};
}

private String getString(CfApplication cfApp, String key) {
return Optional.ofNullable(cfApp)
.map(CfApplication::getMap)
.map(m -> m.get(key))
.filter(String.class::isInstance)
.map(String.class::cast)
.orElse("");
private String rename(AttributeKey<?> key) {
String name = key.getKey();
return SAP_CF_RESOURCE_ATTRIBUTES.getOrDefault(name, name);
}
}
44 changes: 44 additions & 0 deletions .../java/com/sap/hcf/cf/logging/opentelemetry/agent/ext/binding/CloudFoundryCredentials.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
package com.sap.hcf.cf.logging.opentelemetry.agent.ext.binding;

import java.util.Map;
import java.util.TreeMap;

public class CloudFoundryCredentials {

private final Map<String, String> properties;

private CloudFoundryCredentials(Builder builder) {
this.properties = builder.properties;
}

public String getString(String key) {
return properties.get(key);
}

public static Builder builder() {
return new Builder();
}

public static class Builder {

private final Map<String, String> properties = new TreeMap<>();

private Builder() {
}

public CloudFoundryCredentials build() {
return new CloudFoundryCredentials(this);
}

public Builder add(String key, String value) {
if (isNotBlank(key) && isNotBlank(value)) {
properties.put(key, value);
}
return this;
}

private boolean isNotBlank(String string) {
return string != null && !string.trim().isEmpty();
}
}
}
Loading