Default environment

build.gradle

@@ -33,9 +33,12 @@ dependencies {
     implementation 'com.fasterxml.jackson.core:jackson-core:2.11.1'
     implementation 'com.fasterxml.jackson.core:jackson-annotations:2.11.1'
     implementation 'com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.11.1'
+    implementation 'org.slf4j:slf4j-api:1.7.30'
 
     // Use JUnit test framework
     testImplementation 'junit:junit:4.13'
     testImplementation 'org.apache.commons:commons-lang3:3.10'
     testImplementation "org.mockito:mockito-core:2.+"
+    testImplementation "org.powermock:powermock-module-junit4:2.0.2"
+    testImplementation "org.powermock:powermock-api-mockito2:2.0.2"
 }

examples/ErrorHandlingExample.java

@@ -3,9 +3,9 @@
 import software.amazon.awssdk.services.cloudwatchlogs.CloudWatchLogsClient;
 import software.amazon.awssdk.services.cloudwatchlogs.emf.logger.EMFLogger;
 import software.amazon.awssdk.services.cloudwatchlogs.emf.logger.FlushException;
-import software.amazon.awssdk.services.cloudwatchlogs.emf.logger.sinks.CloudWatchLogsClientSink;
-import software.amazon.awssdk.services.cloudwatchlogs.emf.logger.sinks.ConsoleSink;
-import software.amazon.awssdk.services.cloudwatchlogs.emf.logger.sinks.MultiSink;
+import software.amazon.awssdk.services.cloudwatchlogs.emf.sinks.CloudWatchLogsClientSink;
+import software.amazon.awssdk.services.cloudwatchlogs.emf.sinks.ConsoleSink;
+import software.amazon.awssdk.services.cloudwatchlogs.emf.sinks.MultiSink;
 import software.amazon.awssdk.services.cloudwatchlogs.emf.model.CloudwatchMetricCollection;
 import software.amazon.awssdk.services.cloudwatchlogs.emf.model.EMFLogItem;
 

examples/Examples.java

@@ -6,9 +6,9 @@
 import software.amazon.awssdk.services.cloudwatchlogs.CloudWatchLogsClient;
 import software.amazon.awssdk.services.cloudwatchlogs.emf.logger.EMFLogger;
 import software.amazon.awssdk.services.cloudwatchlogs.emf.logger.FlushException;
-import software.amazon.awssdk.services.cloudwatchlogs.emf.logger.sinks.CloudWatchLogsClientSink;
-import software.amazon.awssdk.services.cloudwatchlogs.emf.logger.sinks.ConsoleSink;
-import software.amazon.awssdk.services.cloudwatchlogs.emf.logger.sinks.MultiSink;
+import software.amazon.awssdk.services.cloudwatchlogs.emf.sinks.CloudWatchLogsClientSink;
+import software.amazon.awssdk.services.cloudwatchlogs.emf.sinks.ConsoleSink;
+import software.amazon.awssdk.services.cloudwatchlogs.emf.sinks.MultiSink;
 import software.amazon.awssdk.services.cloudwatchlogs.emf.model.Aggregation;
 import software.amazon.awssdk.services.cloudwatchlogs.emf.model.CloudwatchMetricCollection;
 import software.amazon.awssdk.services.cloudwatchlogs.emf.model.EMFLogItem;

integ/software/amazon/awssdk/services/cloudwatchlogs/emf/IntegrationTestBase.java

@@ -4,7 +4,7 @@
 import software.amazon.awssdk.services.cloudwatch.CloudWatchClient;
 import software.amazon.awssdk.services.cloudwatchlogs.CloudWatchLogsClient;
 import software.amazon.awssdk.services.cloudwatchlogs.emf.logger.EMFLogger;
-import software.amazon.awssdk.services.cloudwatchlogs.emf.logger.sinks.CloudWatchLogsClientSink;
+import software.amazon.awssdk.services.cloudwatchlogs.emf.sinks.CloudWatchLogsClientSink;
 import software.amazon.awssdk.services.cloudwatchlogs.emf.testutils.EMFTestUtilities;
 
 public class IntegrationTestBase {

integ/software/amazon/awssdk/services/cloudwatchlogs/emf/LogItemSizeTest.java

@@ -5,7 +5,7 @@
 import software.amazon.awssdk.services.cloudwatchlogs.emf.logger.CloudWatchLimits;
 import software.amazon.awssdk.services.cloudwatchlogs.emf.logger.EMFLogger;
 import software.amazon.awssdk.services.cloudwatchlogs.emf.logger.FlushException;
-import software.amazon.awssdk.services.cloudwatchlogs.emf.logger.sinks.SinkUtilities;
+import software.amazon.awssdk.services.cloudwatchlogs.emf.sinks.SinkUtilities;
 import software.amazon.awssdk.services.cloudwatchlogs.emf.model.CloudwatchMetricCollection;
 import software.amazon.awssdk.services.cloudwatchlogs.emf.model.EMFLogItem;
 import software.amazon.awssdk.services.cloudwatchlogs.model.GetLogEventsRequest;

src/main/java/software/amazon/awssdk/services/cloudwatchlogs/emf/config/Configuration.java

@@ -0,0 +1,59 @@
+package software.amazon.awssdk.services.cloudwatchlogs.emf.config;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.Setter;
+import software.amazon.awssdk.services.cloudwatchlogs.emf.environment.Environments;
+
+import java.util.Optional;
+
+@AllArgsConstructor
+public class Configuration {
+    /**
+     * Whether or not internal logging should be enabled.
+     */
+    @Getter @Setter
+    boolean debuggingLoggingEnabled;
+
+    /**
+     * The name of the service to use in the default dimensions.
+     */
+    @Getter @Setter
+    Optional<String> serviceName;
+
+    /**
+     * The type of the service to use in the default dimensions.
+     */
+    @Getter @Setter
+    Optional<String> serviceType;
+
+    /**
+     * The LogGroup name to use. This is only used for the Cloudwatch Agent in agent-based environment.
+     */
+    @Getter @Setter
+    Optional<String> logGroupName;
+
+    /**
+     * The LogStream name to use. This will be ignored when using the
+     * Lambda scope.
+     */
+    @Getter @Setter
+    Optional<String> logStreamName;
+
+    /**
+     * The endpoint to use to connect to the CloudWatch Agent
+     */
+    @Getter @Setter
+    Optional<String> agentEndpoint;
+
+    /**
+     * Environment override. This will short circuit auto-environment detection.
+     * Valid values include:
+     * - Local: no decoration and sends over stdout
+     * - Lambda: decorates logs with Lambda metadata and sends over stdout
+     * - Agent: no decoration and sends over TCP
+     * - EC2: decorates logs with EC2 metadata and sends over TCP
+     */
+    @Getter @Setter
+    Environments environmentOverride;
+}

src/main/java/software/amazon/awssdk/services/cloudwatchlogs/emf/config/ConfigurationKeys.java

@@ -0,0 +1,14 @@
+package software.amazon.awssdk.services.cloudwatchlogs.emf.config;
+
+public class ConfigurationKeys {
+
+    public static final String ENV_VAR_PREFIX = "AWS_EMF";
+
+    public static final String ENABLE_DEBUG_LOGGING = "ENABLE_DEBUG_LOGGING";
+    public static final String SERVICE_NAME = "SERVICE_NAME";
+    public static final String SERVICE_TYPE = "SERVICE_TYPE";
+    public static final String LOG_GROUP_NAME = "LOG_GROUP_NAME";
+    public static final String LOG_STREAM_NAME = "LOG_STREAM_NAME";
+    public static final String AGENT_ENDPOINT = "AGENT_ENDPOINT";
+    public static final String ENVIRONMENT_OVERRIDE = "ENVIRONMENT";
+}

src/main/java/software/amazon/awssdk/services/cloudwatchlogs/emf/config/EnvironmentConfigurationProvider.java

@@ -0,0 +1,57 @@
+package software.amazon.awssdk.services.cloudwatchlogs.emf.config;
+
+import software.amazon.awssdk.services.cloudwatchlogs.emf.environment.Environments;
+
+import java.util.Optional;
+
+/**
+ * Loads configuration from environment variables
+ */
+public class EnvironmentConfigurationProvider {
+    private static Configuration config;
+
+    protected EnvironmentConfigurationProvider() {}
+
+    public static Configuration getConfig() {
+        if (config == null) {
+            config = new Configuration(
+                    getBoolEnvVar(ConfigurationKeys.ENABLE_DEBUG_LOGGING),
+                    getEnvVar(ConfigurationKeys.SERVICE_NAME),
+                    getEnvVar(ConfigurationKeys.SERVICE_TYPE),
+                    getEnvVar(ConfigurationKeys.LOG_GROUP_NAME),
+                    getEnvVar(ConfigurationKeys.LOG_STREAM_NAME),
+                    getEnvVar(ConfigurationKeys.AGENT_ENDPOINT),
+                    getEnvironmentOverride()
+            );
+        }
+        return config;
+    }
+
+    private static Optional<String> getEnvVar(String key) {
+        String name = String.join("", ConfigurationKeys.ENV_VAR_PREFIX, "_", key);
+        return Optional.ofNullable(getEnv(name));
+    }
+
+    private static boolean getBoolEnvVar(String key) {
+        String name = String.join("", ConfigurationKeys.ENV_VAR_PREFIX, "_", key);
+        return Optional.ofNullable(getEnv(name)).map(str -> str.equalsIgnoreCase("true")).orElse(false);
+    }
+
+    private static Environments getEnvironmentOverride() {
+        Optional<String> environmentName = getEnvVar(ConfigurationKeys.ENVIRONMENT_OVERRIDE);
+        if (!environmentName.isPresent()) {
+            return Environments.Unknown;
+        }
+
+        try {
+            return Environments.valueOf(environmentName.get());
+        } catch (Exception e) {
+            return Environments.Unknown;
+        }
+    }
+
+    private static String getEnv(String name) {
+        return SystemWrapper.getenv(name);
+    }
+
+}

src/main/java/software/amazon/awssdk/services/cloudwatchlogs/emf/config/SystemWrapper.java

@@ -0,0 +1,7 @@
+package software.amazon.awssdk.services.cloudwatchlogs.emf.config;
+
+class SystemWrapper {
+    static String getenv(String name) {
+        return System.getenv(name);
+    }
+}

src/main/java/software/amazon/awssdk/services/cloudwatchlogs/emf/environment/DefaultEnvironment.java

@@ -0,0 +1,73 @@
+package software.amazon.awssdk.services.cloudwatchlogs.emf.environment;
+
+import lombok.extern.slf4j.Slf4j;
+import software.amazon.awssdk.services.cloudwatchlogs.emf.config.Configuration;
+import software.amazon.awssdk.services.cloudwatchlogs.emf.sinks.AgentSink;
+import software.amazon.awssdk.services.cloudwatchlogs.emf.sinks.Endpoint;
+import software.amazon.awssdk.services.cloudwatchlogs.emf.sinks.ISink;
+import software.amazon.awssdk.services.cloudwatchlogs.emf.model.MetricsContext;
+import software.amazon.awssdk.services.cloudwatchlogs.emf.sinks.SocketClientFactory;
+
+
+@Slf4j
+public class DefaultEnvironment implements Environment {
+    private Configuration config;
+    private ISink sink;
+
+    public DefaultEnvironment(Configuration config) {
+        this.config = config;
+    }
+
+
+    @Override
+    public boolean probe() {
+        return true;
+    }
+
+    @Override
+    public String getName() {
+        if (!config.getServiceName().isPresent()) {
+            log.info("Unknown ServiceName");
+            return "Unknown";
+        }
+        return config.getServiceName().get();
+    }
+
+    @Override
+    public String getType() {
+        if (!config.getServiceType().isPresent()) {
+            log.info("Unknown ServiceType");
+            return "Unknown";
+        }
+        return config.getServiceType().get();
+    }
+
+    public String getLogStreamName() {
+        return  config.getLogStreamName().orElse(getName() + "-stream");
+    }
+
+    @Override
+    public String getLogGroupName() {
+        return  config.getLogGroupName().orElse(getName() + "-metrics");
+    }
+
+    @Override
+    public void configureContext(MetricsContext context) {
+        // no-op
+    }
+
+    @Override
+    public ISink getSink() {
+        if (sink == null) {
+            Endpoint endpoint;
+            if (!config.getAgentEndpoint().isPresent()) {
+                log.info("Endpoint is not defined. Using default: {}", Endpoint.DEFAULT_TCP_ENDPOINT);
+                endpoint = Endpoint.DEFAULT_TCP_ENDPOINT;
+            } else {
+                endpoint = Endpoint.fromURL(config.getAgentEndpoint().get());
+            }
+            sink = new AgentSink(getLogGroupName(), getLogStreamName(),  endpoint, new SocketClientFactory());
+        }
+        return sink;
+    }
+}

src/main/java/software/amazon/awssdk/services/cloudwatchlogs/emf/environment/Environment.java

@@ -0,0 +1,41 @@
+package software.amazon.awssdk.services.cloudwatchlogs.emf.environment;
+
+import software.amazon.awssdk.services.cloudwatchlogs.emf.sinks.ISink;
+import software.amazon.awssdk.services.cloudwatchlogs.emf.model.MetricsContext;
+
+/**
+ * A runtime environment (e.g. Lambda, EKS, ECS, EC2)
+ */
+public interface Environment {
+    /**
+     * Determines whether or not we are executing in this environment
+     */
+    boolean probe();
+
+    /**
+     * Get the environment name. This will be used to set the ServiceName dimension.
+     */
+    String getName();
+
+    /**
+     * Get the environment type. This will be used to set the ServiceType dimension.
+     */
+    String getType();
+
+    /**
+     * Get log group name. This will be used to set the LogGroup dimension.
+     */
+    String getLogGroupName();
+
+    /**
+     * Configure the context with environment properties.
+     *
+     * @param context
+     */
+    void configureContext(MetricsContext context);
+
+    /**
+     * Create the appropriate sink for this environment.
+     */
+    ISink getSink();
+}

src/main/java/software/amazon/awssdk/services/cloudwatchlogs/emf/environment/EnvironmentProvider.java

@@ -0,0 +1,11 @@
+package software.amazon.awssdk.services.cloudwatchlogs.emf.environment;
+
+import software.amazon.awssdk.services.cloudwatchlogs.emf.config.EnvironmentConfigurationProvider;
+
+public class EnvironmentProvider {
+
+    //TODO: Support more environments
+    public Environment resolveEnvironment() {
+        return new DefaultEnvironment(EnvironmentConfigurationProvider.getConfig());
+    }
+}

src/main/java/software/amazon/awssdk/services/cloudwatchlogs/emf/environment/Environments.java

@@ -0,0 +1,5 @@
+package software.amazon.awssdk.services.cloudwatchlogs.emf.environment;
+
+public enum Environments {
+    Local, Lambda, Agent, EC2, ECS, Unknown
+}

src/main/java/software/amazon/awssdk/services/cloudwatchlogs/emf/logger/EMFLogger.java

@@ -4,7 +4,7 @@
 import lombok.Builder;
 import lombok.Getter;
 import lombok.NonNull;
-import software.amazon.awssdk.services.cloudwatchlogs.emf.logger.sinks.ISink;
+import software.amazon.awssdk.services.cloudwatchlogs.emf.sinks.ISink;
 import software.amazon.awssdk.services.cloudwatchlogs.emf.model.EMFLogItem;
 
 import java.util.ArrayList;

src/main/java/software/amazon/awssdk/services/cloudwatchlogs/emf/logger/FlushException.java

@@ -51,6 +51,10 @@ public FlushException(List<EMFLogItem> failedLogItems, List<EMFLogItem> unproces
         this.unprocessedLogItems = unprocessedLogItems;
     }
 
+    public FlushException(String message, Throwable cause) {
+        super(message, cause);
+    }
+
     // Internal constructor for handling errors before all information is available
     protected FlushException(String message) {
         super(message);