Skip to content

Commit c8a444b

Browse files
committed
improve: metrics processing to showcase all operations
- rename of the module to operations - showcase health probes Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
1 parent b32b4f7 commit c8a444b

File tree

19 files changed

+19
-19
lines changed

19 files changed

+19
-19
lines changed

.github/workflows/e2e-test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ jobs:
2424
- "sample-operators/tomcat-operator"
2525
- "sample-operators/webpage"
2626
- "sample-operators/leader-election"
27-
- "sample-operators/metrics-processing"
27+
- "sample-operators/operations"
2828
runs-on: ubuntu-latest
2929
steps:
3030
- name: Checkout

docs/content/en/blog/releases/v5-3-release.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ A ready-to-use **Grafana dashboard** is included at
9797
[`observability/josdk-operator-metrics-dashboard.json`](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/observability/josdk-operator-metrics-dashboard.json).
9898

9999
The
100-
[`metrics-processing` sample operator](https://github.com/java-operator-sdk/java-operator-sdk/tree/main/sample-operators/metrics-processing)
100+
[`operations` sample operator](https://github.com/java-operator-sdk/java-operator-sdk/tree/main/sample-operators/operations)
101101
provides a complete end-to-end setup with Prometheus, Grafana, and an OpenTelemetry Collector,
102102
installable via `observability/install-observability.sh`. This is a good starting point for
103103
verifying metrics in a real cluster.

docs/content/en/docs/documentation/operations/helm-chart.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ patterns so you don't have to write a chart from scratch. The chart is maintaine
1111
Contributions are more than welcome.
1212

1313
The chart is used in the
14-
[`metrics-processing` sample operator E2E test](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/sample-operators/metrics-processing/src/test/java/io/javaoperatorsdk/operator/sample/metrics/MetricsHandlingE2E.java)
14+
[`operations` sample operator E2E test](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/sample-operators/operations/src/test/java/io/javaoperatorsdk/operator/sample/metrics/MetricsHandlingE2E.java)
1515
to deploy the operator to a cluster via Helm.
1616

1717
## What the Chart Provides
@@ -80,16 +80,16 @@ for all available options.
8080

8181
## Usage Example
8282

83-
A working example of how to use the chart can be found in the metrics-processing sample operator's
84-
[`helm-values.yaml`](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/sample-operators/metrics-processing/src/test/resources/helm-values.yaml):
83+
A working example of how to use the chart can be found in the operations sample operator's
84+
[`helm-values.yaml`](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/sample-operators/operations/src/test/resources/helm-values.yaml):
8585

8686
```yaml
8787
image:
88-
repository: metrics-processing-operator
88+
repository: operations-operator
8989
pullPolicy: Never
9090
tag: "latest"
9191
92-
nameOverride: "metrics-processing-operator"
92+
nameOverride: "operations-operator"
9393
9494
resources: {}
9595

docs/content/en/docs/documentation/operations/metrics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,9 @@ observability sample (see below).
103103
#### Exploring metrics end-to-end
104104

105105
The
106-
[`metrics-processing` sample operator](https://github.com/java-operator-sdk/java-operator-sdk/tree/main/sample-operators/metrics-processing)
106+
[`operations` sample operator](https://github.com/java-operator-sdk/java-operator-sdk/tree/main/sample-operators/operations)
107107
includes a full end-to-end test,
108-
[`MetricsHandlingE2E`](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/sample-operators/metrics-processing/src/test/java/io/javaoperatorsdk/operator/sample/metrics/MetricsHandlingE2E.java),
108+
[`MetricsHandlingE2E`](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/sample-operators/operations/src/test/java/io/javaoperatorsdk/operator/sample/metrics/MetricsHandlingE2E.java),
109109
that:
110110

111111
1. Installs a local observability stack (Prometheus, Grafana, OpenTelemetry Collector) via

sample-operators/metrics-processing/pom.xml renamed to sample-operators/operations/pom.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@
2525
<version>5.3.4-SNAPSHOT</version>
2626
</parent>
2727

28-
<artifactId>sample-metrics-processing</artifactId>
28+
<artifactId>sample-operations</artifactId>
2929
<packaging>jar</packaging>
30-
<name>Operator SDK - Samples - Metrics processing</name>
31-
<description>Showcases to handle metrics setup and deploys related tooling and dashboards</description>
30+
<name>Operator SDK - Samples - Operations</name>
31+
<description>Showcases operations related features setup like metrics, and deploys related tooling and dashboards</description>
3232

3333
<dependencyManagement>
3434
<dependencies>
@@ -99,7 +99,7 @@
9999
<image>gcr.io/distroless/java17-debian11</image>
100100
</from>
101101
<to>
102-
<image>metrics-processing-operator</image>
102+
<image>operations-operator</image>
103103
</to>
104104
<container>
105105
<jvmFlags>

sample-operators/metrics-processing/src/main/java/io/javaoperatorsdk/operator/sample/metrics/AbstractMetricsHandlingReconciler.java renamed to sample-operators/operations/src/main/java/io/javaoperatorsdk/operator/sample/metrics/AbstractMetricsHandlingReconciler.java

File renamed without changes.

sample-operators/metrics-processing/src/main/java/io/javaoperatorsdk/operator/sample/metrics/MetricsHandlingReconciler1.java renamed to sample-operators/operations/src/main/java/io/javaoperatorsdk/operator/sample/metrics/MetricsHandlingReconciler1.java

File renamed without changes.

sample-operators/metrics-processing/src/main/java/io/javaoperatorsdk/operator/sample/metrics/MetricsHandlingReconciler2.java renamed to sample-operators/operations/src/main/java/io/javaoperatorsdk/operator/sample/metrics/MetricsHandlingReconciler2.java

File renamed without changes.

sample-operators/metrics-processing/src/main/java/io/javaoperatorsdk/operator/sample/metrics/MetricsHandlingSampleOperator.java renamed to sample-operators/operations/src/main/java/io/javaoperatorsdk/operator/sample/metrics/MetricsHandlingSampleOperator.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ public static void main(String[] args) {
9696

9797
@Override
9898
public Map<String, String> resourceAttributes() {
99-
return Map.of("service.name", "josdk", "operator", "metrics-processing");
99+
return Map.of("service.name", "josdk", "operator", "operations");
100100
}
101101
};
102102

sample-operators/metrics-processing/src/main/java/io/javaoperatorsdk/operator/sample/metrics/customresource/MetricsHandlingCustomResource1.java renamed to sample-operators/operations/src/main/java/io/javaoperatorsdk/operator/sample/metrics/customresource/MetricsHandlingCustomResource1.java

File renamed without changes.

0 commit comments

Comments
 (0)