Initial proposal for providing access to JFR profiles from within Application Insights (#1513)

Author: johnoliver

agent/agent-profiler/agent-alerting-api/build.gradle

@@ -0,0 +1,9 @@
+group = 'io.opentelemetry.javaagent'
+
+apply from: "$buildScriptsDir/common-java.gradle"
+apply from: "$buildScriptsDir/publishing.gradle"
+
+dependencies {
+    testCompile group: 'junit', name: 'junit', version: '4.12'
+    testCompile 'org.mockito:mockito-core:1.10.19'
+}

agent/agent-profiler/agent-alerting-api/gradle/dependency-locks/compileClasspath.lockfile

@@ -0,0 +1,3 @@
+# This is a Gradle generated file for dependency locking.
+# Manual edits can break the build and are not advised.
+# This file is expected to be part of source control.

agent/agent-profiler/agent-alerting-api/gradle/dependency-locks/runtimeClasspath.lockfile

@@ -0,0 +1,3 @@
+# This is a Gradle generated file for dependency locking.
+# Manual edits can break the build and are not advised.
+# This file is expected to be part of source control.

agent/agent-profiler/agent-alerting-api/src/main/java/com/microsoft/applicationinsights/alerting/alert/AlertBreach.java

@@ -0,0 +1,86 @@
+/*
+ * ApplicationInsights-Java
+ * Copyright (c) Microsoft Corporation
+ * All rights reserved.
+ *
+ * MIT License
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this
+ * software and associated documentation files (the ""Software""), to deal in the Software
+ * without restriction, including without limitation the rights to use, copy, modify, merge,
+ * publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+ * persons to whom the Software is furnished to do so, subject to the following conditions:
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ * THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+ * PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
+ * FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+package com.microsoft.applicationinsights.alerting.alert;
+
+import com.microsoft.applicationinsights.alerting.config.AlertingConfiguration.AlertConfiguration;
+
+/**
+ * Represents a breach of an alert threshold
+ */
+public class AlertBreach {
+    private final AlertMetricType type;
+
+    // Value of the telemetry at the time of the breach
+    private final double alertValue;
+
+    private final AlertConfiguration alertConfiguration;
+
+    // CPU usage at the time of the breach
+    private final double cpuUsage;
+
+    // MEMORY usage at the time of the breach
+    private final double memoryUsage;
+
+    public AlertBreach(AlertMetricType type, double alertValue, AlertConfiguration alertConfiguration) {
+        this(type, alertValue, alertConfiguration, 0, 0);
+    }
+
+    public AlertBreach(AlertMetricType type, double alertValue, AlertConfiguration alertConfiguration, double cpuUsage, double memoryUsage) {
+        this.type = type;
+        this.alertValue = alertValue;
+        this.alertConfiguration = alertConfiguration;
+        this.cpuUsage = cpuUsage;
+        this.memoryUsage = memoryUsage;
+
+    }
+
+    public AlertConfiguration getAlertConfiguration() {
+        return alertConfiguration;
+    }
+
+    public double getAlertValue() {
+        return alertValue;
+    }
+
+    public AlertMetricType getType() {
+        return type;
+    }
+
+    public AlertBreach withCpuMetric(double cpuUsage) {
+        return new AlertBreach(type, alertValue, alertConfiguration, cpuUsage, memoryUsage);
+    }
+
+    public AlertBreach withMemoryMetric(double memoryUsage) {
+        return new AlertBreach(type, alertValue, alertConfiguration, cpuUsage, memoryUsage);
+    }
+
+    public String getTriggerName() {
+        return "JFR-" + type.name();
+    }
+
+    public double getCpuMetric() {
+        return cpuUsage;
+    }
+
+    public double getMemoryUsage() {
+        return memoryUsage;
+    }
+}

agent/agent-profiler/agent-alerting-api/src/main/java/com/microsoft/applicationinsights/alerting/alert/AlertMetricType.java

@@ -0,0 +1,28 @@
+/*
+ * ApplicationInsights-Java
+ * Copyright (c) Microsoft Corporation
+ * All rights reserved.
+ *
+ * MIT License
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this
+ * software and associated documentation files (the ""Software""), to deal in the Software
+ * without restriction, including without limitation the rights to use, copy, modify, merge,
+ * publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+ * persons to whom the Software is furnished to do so, subject to the following conditions:
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ * THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+ * PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
+ * FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+package com.microsoft.applicationinsights.alerting.alert;
+
+public enum AlertMetricType {
+    CPU,
+    MEMORY,
+    PERIODIC,
+    MANUAL
+}

agent/agent-profiler/agent-alerting-api/src/main/java/com/microsoft/applicationinsights/alerting/config/AlertingConfiguration.java

@@ -0,0 +1,180 @@
+/*
+ * ApplicationInsights-Java
+ * Copyright (c) Microsoft Corporation
+ * All rights reserved.
+ *
+ * MIT License
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this
+ * software and associated documentation files (the ""Software""), to deal in the Software
+ * without restriction, including without limitation the rights to use, copy, modify, merge,
+ * publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+ * persons to whom the Software is furnished to do so, subject to the following conditions:
+ * The above copyright notice and this permission notice shall be included in all copies or
+ * substantial portions of the Software.
+ * THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+ * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+ * PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
+ * FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+package com.microsoft.applicationinsights.alerting.config;
+
+import java.util.Objects;
+
+import com.microsoft.applicationinsights.alerting.alert.AlertMetricType;
+
+/**
+ * Contains the overall configuration of the entire alerting subsystem
+ */
+public class AlertingConfiguration {
+
+    // Alert configuration for CPU telemetry
+    private final AlertConfiguration cpuAlert;
+
+    // Alert configuration for MEMORY telemetry
+    private final AlertConfiguration memoryAlert;
+
+    // Alert configuration for the periodic profiling
+    private final DefaultConfiguration defaultConfiguration;
+
+    // Alert configuration for manual profiling
+    private final CollectionPlanConfiguration collectionPlanConfiguration;
+
+    public AlertingConfiguration(AlertConfiguration cpuAlert, AlertConfiguration memoryAlert, DefaultConfiguration defaultConfiguration,
+                                 CollectionPlanConfiguration collectionPlanConfiguration) {
+        this.cpuAlert = cpuAlert;
+        this.memoryAlert = memoryAlert;
+        this.defaultConfiguration = defaultConfiguration;
+        this.collectionPlanConfiguration = collectionPlanConfiguration;
+    }
+
+    public DefaultConfiguration getDefaultConfiguration() {
+        return defaultConfiguration;
+    }
+
+    public AlertConfiguration getCpuAlert() {
+        return cpuAlert;
+    }
+
+    public AlertConfiguration getMemoryAlert() {
+        return memoryAlert;
+    }
+
+    public CollectionPlanConfiguration getCollectionPlanConfiguration() {
+        return collectionPlanConfiguration;
+    }
+
+    @Override public boolean equals(Object o) {
+        if (this == o) return true;
+        if (o == null || getClass() != o.getClass()) return false;
+        AlertingConfiguration that = (AlertingConfiguration) o;
+        return Objects.equals(cpuAlert, that.cpuAlert) && Objects.equals(memoryAlert, that.memoryAlert) && Objects.equals(defaultConfiguration, that.defaultConfiguration) &&
+                Objects.equals(collectionPlanConfiguration, that.collectionPlanConfiguration);
+    }
+
+    @Override public int hashCode() {
+        return Objects.hash(cpuAlert, memoryAlert, defaultConfiguration, collectionPlanConfiguration);
+    }
+
+    /**
+     * Alert configuration for a given telemetry type
+     */
+    public static class AlertConfiguration {
+
+        private final AlertMetricType type;
+        private final boolean enabled;
+        private final float threshold;
+        private final long profileDuration;
+        private final long cooldown;
+
+        public AlertConfiguration(AlertMetricType type, boolean enabled, float threshold, long profileDuration, long cooldown) {
+            this.type = type;
+            this.enabled = enabled;
+            this.threshold = threshold;
+            this.profileDuration = profileDuration;
+            this.cooldown = cooldown;
+        }
+
+        public boolean isEnabled() {
+            return enabled;
+        }
+
+        public float getThreshold() {
+            return threshold;
+        }
+
+        public long getProfileDuration() {
+            return profileDuration;
+        }
+
+        public long getCooldown() {
+            return cooldown;
+        }
+
+        @Override public boolean equals(Object o) {
+            if (this == o) return true;
+            if (o == null || getClass() != o.getClass()) return false;
+            AlertConfiguration that = (AlertConfiguration) o;
+            return enabled == that.enabled &&
+                    Float.compare(that.threshold, threshold) == 0 &&
+                    profileDuration == that.profileDuration &&
+                    cooldown == that.cooldown;
+        }
+
+        @Override public int hashCode() {
+            return Objects.hash(enabled, threshold, profileDuration, cooldown);
+        }
+
+        public AlertMetricType getType() {
+            return type;
+        }
+
+        @Override public String toString() {
+            return "AlertConfiguration{" +
+                    "type=" + type +
+                    ", enabled=" + enabled +
+                    ", threshold=" + threshold +
+                    ", profileDuration=" + profileDuration +
+                    ", cooldown=" + cooldown +
+                    '}';
+        }
+    }
+
+    public static class AlertConfigurationBuilder {
+        private boolean enabled;
+        private float threshold;
+        private long profileDuration;
+        private long cooldown;
+        private AlertMetricType type;
+
+        public AlertConfigurationBuilder setEnabled(boolean enabled) {
+            this.enabled = enabled;
+            return this;
+        }
+
+        public AlertConfigurationBuilder setThreshold(float threshold) {
+            this.threshold = threshold;
+            return this;
+        }
+
+        public AlertConfigurationBuilder setProfileDuration(long profileDuration) {
+            this.profileDuration = profileDuration;
+            return this;
+        }
+
+        public AlertConfigurationBuilder setCooldown(long cooldown) {
+            this.cooldown = cooldown;
+            return this;
+        }
+
+        public AlertConfigurationBuilder setType(AlertMetricType type) {
+            this.type = type;
+            return this;
+        }
+
+        public AlertConfiguration createAlertConfiguration() {
+            return new AlertConfiguration(type, enabled, threshold, profileDuration, cooldown);
+        }
+    }
+}