Merge remote-tracking branch 'origin/master'

# Conflicts:
#	.github/workflows/on_release.yml

Author: Umaaz

.github/workflows/on_push.yml

@@ -46,6 +46,7 @@ jobs:
           java-version: '11'
           distribution: 'temurin'
           cache: 'maven'
+
       - name: Check Formatting
         run: make lint
 
@@ -60,6 +61,7 @@ jobs:
           java-version: '11'
           distribution: 'temurin'
           cache: 'maven'
+
       - name: Run PMD check
         run: make pmd
 
@@ -75,6 +77,21 @@ jobs:
           java-version: '11'
           distribution: 'temurin'
           cache: 'maven'
+
       - name: Run docs check
         run: make docs
 
+  compile:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          java-version: '11'
+          distribution: 'temurin'
+          cache: 'maven'
+
+      - name: Run compile check
+        run: make compile

.idea/encodings.xml

@@ -1,3 +1,4 @@
 # Enable auto-env through the sdkman_auto_env config
 # Add key=value pairs of SDKs to use below
 java=13.0.2-open
+maven=3.9.6

.idea/inspectionProfiles/Project_Default.xml

@@ -1,5 +1,7 @@
 # 1.2.0 (xx/xx/2023)
+- **[CHANGE]**: update:  Update deep proto to 1.0.3 [#74](https://github.com/intergral/deep/pull/74) [@Umaaz](https://github.com/Umaaz)
 - **[CHANGE]**: plugin: Change the plugins to use SPI to load [#77](https://github.com/intergral/deep/pull/77) [@Umaaz](https://github.com/Umaaz)
+- **[FEATURE]**: metrics: Add support for metrics from tracepoints [#74](https://github.com/intergral/deep/pull/74) [@Umaaz](https://github.com/Umaaz)
 
 # 1.1.2 (29/09/2023)
 - **[CHANGE]**: version: Override grpc-netty dependencies to remove CVE [#44](https://github.com/intergral/deep/pull/44) [@LMarkie](https://github.com/LMarkie)

.sdkman

@@ -1,46 +1,61 @@
+# This file just contains shortcuts for dev, as there are a lot of options for different builds
 
-
+# Run the PMD check - while skipping tests
+# Doesn't run PMD on it tests or examples
 .PHONY: pmd
 pmd:
 	mvn -U -B verify -Ppmd -DskipTests $(MVN_ARGS)
 
+# Run lint on all code
 ,PHONY: lint
 lint:
 	mvn -U -B validate -Plint,examples,cf-it-tests $(MVN_ARGS)
 
+# Package and verify all code expect cf-tests and examples
 .PHONY: test
 test:
 	mvn -U -B clean verify $(MVN_ARGS)
 
+# Generate documentation from source
 .PHONY: docs
 docs:
 	mvn -s .ci-settings.xml clean package javadoc:jar -DskipTests -P release-ossrh -B -U -pl agent,deep --also-make $(MVN_ARGS)
 
+# Generate the agent and rebuild all the dependant modules
 .PHONY: package-agent
 package:
 	mvn package -U -B -pl agent --also-make -DskipTests $(MVN_ARGS)
 
+# Run the CF it tests
 .PHONY: cf-tests
 cf-tests: package
 	mvn verify -U -B -P cf-it-tests -pl it-tests/cf-tests --also-make $(MVN_ARGS)
-# This file just contains shortcuts for dev, as there are a lot of options for different builds
 
+# Build the agent and deep, also rebuild all dependant modules
 .PHONY: build
 build:
 	mvn clean package -U -B -pl agent,deep --also-make $(MVN_ARGS)
 
-
+# Install the agent and deep into the local repo (~/.m2)
 .PHONY: install
 install:
 	mvn clean install -U -B -pl agent,deep --also-make $(MVN_ARGS)
 
+# Run the coverage checks
 .PHONY: coverage
 coverage:
 	mvn clean verify -U -B -P coverage -pl '!it-tests/java-tests,!it-tests'
 
+# Compile all modules
+.PHONY: compile
+compile:
+	mvn clean compile -U -B -P cf-it-tests,coverage,docs,examples,lint,pmd
+
+# Combine a few common checks in a single task
 .PHONY: precommit
 precommit:
 	$(MAKE) lint
 	$(MAKE) pmd
 	$(MAKE) coverage
-	$(MAKE) docs
+	$(MAKE) docs
+	$(MAKE) compile

.sdkmanrc

@@ -17,6 +17,7 @@
 
 package com.intergral.deep.agent.api;
 
+import com.intergral.deep.agent.api.plugin.MetricDefinition;
 import com.intergral.deep.agent.api.tracepoint.ITracepoint.ITracepointRegistration;
 import java.util.Collection;
 import java.util.Map;
@@ -70,8 +71,9 @@ public interface IDeep {
    * @param line the line number
    * @param args the key value pairs that further define the tracepoint
    * @param watches the list of watch expressions
+   * @param metrics the list of metric expressions
    * @return a {@link ITracepointRegistration} that can be used to remove the tracepoint
    */
   ITracepointRegistration registerTracepoint(final String path, final int line, final Map<String, String> args,
-      final Collection<String> watches);
+      final Collection<String> watches, final Collection<MetricDefinition> metrics);
 }

CHANGELOG.md

@@ -0,0 +1,79 @@
+/*
+ *     Copyright (C) 2023  Intergral GmbH
+ *
+ *     This program is free software: you can redistribute it and/or modify
+ *     it under the terms of the GNU Affero General Public License as published by
+ *     the Free Software Foundation, either version 3 of the License, or
+ *     (at your option) any later version.
+ *
+ *     This program is distributed in the hope that it will be useful,
+ *     but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *     GNU Affero General Public License for more details.
+ *
+ *     You should have received a copy of the GNU Affero General Public License
+ *     along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.intergral.deep.agent.api.plugin;
+
+import java.util.Map;
+
+/**
+ * This type defines a processor for metrics. This type can be added to plugins to allow metric generated by tracepoints to be attached to
+ * various metric engines.
+ */
+public interface IMetricProcessor {
+
+  /**
+   * Process a counter type metric.
+   *
+   * @param name      the name of the metric
+   * @param labels      the labels attached to the metric
+   * @param namespace the namespace the metric should be in
+   * @param help      the help statement for the metric
+   * @param unit      the unit for the metric
+   * @param value     the value to post to the metric
+   */
+  void counter(final String name, final Map<String, Object> labels, final String namespace, final String help, final String unit,
+      final Double value);
+
+  /**
+   * Process a gauge type metric.
+   *
+   * @param name      the name of the metric
+   * @param labels      the labels attached to the metric
+   * @param namespace the namespace the metric should be in
+   * @param help      the help statement for the metric
+   * @param unit      the unit for the metric
+   * @param value     the value to post to the metric
+   */
+  void gauge(final String name, final Map<String, Object> labels, final String namespace, final String help, final String unit,
+      final Double value);
+
+  /**
+   * Process a histogram type metric.
+   *
+   * @param name      the name of the metric
+   * @param labels      the labels attached to the metric
+   * @param namespace the namespace the metric should be in
+   * @param help      the help statement for the metric
+   * @param unit      the unit for the metric
+   * @param value     the value to post to the metric
+   */
+  void histogram(final String name, final Map<String, Object> labels, final String namespace, final String help, final String unit,
+      final Double value);
+
+  /**
+   * Process a summary type metric.
+   *
+   * @param name      the name of the metric
+   * @param labels      the labels attached to the metric
+   * @param namespace the namespace the metric should be in
+   * @param help      the help statement for the metric
+   * @param unit      the unit for the metric
+   * @param value     the value to post to the metric
+   */
+  void summary(final String name, final Map<String, Object> labels, final String namespace, final String help, final String unit,
+      final Double value);
+}