Skip to content

[WIP] improve: health probes showcase & docs to operations #3291

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

Draft
csviri wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

[WIP] improve: health probes showcase & docs to operations #3291

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8a444b
improve: metrics processing to showcase all operations
csviri Apr 13, 2026
374e732
wip
csviri Apr 13, 2026
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
2 changes: 1 addition & 1 deletion .github/workflows/e2e-test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ jobs:
- "sample-operators/tomcat-operator"
- "sample-operators/webpage"
- "sample-operators/leader-election"
- "sample-operators/metrics-processing"
- "sample-operators/operations"
Copy link

Copilot AI Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The E2E workflow now targets sample-operators/operations. If the module directory isn’t actually renamed in this PR (the diff still shows tests/resources under sample-operators/metrics-processing), CI will likely fail because the path won’t exist. Align the workflow path with the actual checked-in directory name, or include the directory rename in the PR.

Suggested change
- "sample-operators/operations"
- "sample-operators/metrics-processing"

Copilot uses AI. Check for mistakes.
runs-on: ubuntu-latest
steps:
- name: Checkout
Expand Down
2 changes: 1 addition & 1 deletion docs/content/en/blog/releases/v5-3-release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ A ready-to-use **Grafana dashboard** is included at
[`observability/josdk-operator-metrics-dashboard.json`](https://github.com/java-operator-sdk/java-operator-sdk/blob/main/observability/josdk-operator-metrics-dashboard.json).

The
[`metrics-processing` sample operator](https://github.com/java-operator-sdk/java-operator-sdk/tree/main/sample-operators/metrics-processing)
[`operations` sample operator](https://github.com/java-operator-sdk/java-operator-sdk/tree/main/sample-operators/operations)
provides a complete end-to-end setup with Prometheus, Grafana, and an OpenTelemetry Collector,
installable via `observability/install-observability.sh`. This is a good starting point for
verifying metrics in a real cluster.
Expand Down
10 changes: 5 additions & 5 deletions docs/content/en/docs/documentation/operations/helm-chart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ patterns so you don't have to write a chart from scratch. The chart is maintaine
Contributions are more than welcome.

The chart is used in the
[`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)
[`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)
to deploy the operator to a cluster via Helm.

## What the Chart Provides
Expand Down Expand Up @@ -80,16 +80,16 @@ for all available options.

## Usage Example

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

```yaml
image:
repository: metrics-processing-operator
repository: operations-operator
pullPolicy: Never
tag: "latest"

nameOverride: "metrics-processing-operator"
nameOverride: "operations-operator"

resources: {}

Expand Down
4 changes: 2 additions & 2 deletions docs/content/en/docs/documentation/operations/metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,9 @@ observability sample (see below).
#### Exploring metrics end-to-end

The
[`metrics-processing` sample operator](https://github.com/java-operator-sdk/java-operator-sdk/tree/main/sample-operators/metrics-processing)
[`operations` sample operator](https://github.com/java-operator-sdk/java-operator-sdk/tree/main/sample-operators/operations)
includes a full end-to-end test,
[`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),
[`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),
Comment on lines +106 to +108
Copy link

Copilot AI Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs links were updated to point at sample-operators/operations/..., but in this PR diff the referenced files are still located under sample-operators/metrics-processing/.... If the directory rename isn’t part of the PR, these links will be broken. Either include the directory move/rename so the links resolve, or update the links to match the actual location.

Copilot uses AI. Check for mistakes.
that:

1. Installs a local observability stack (Prometheus, Grafana, OpenTelemetry Collector) via
Expand Down
8 changes: 4 additions & 4 deletions sample-operators/metrics-processing/pom.xml → sample-operators/operations/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@
<version>5.3.4-SNAPSHOT</version>
</parent>

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

<dependencyManagement>
<dependencies>
Expand Down Expand Up @@ -99,7 +99,7 @@
<image>gcr.io/distroless/java17-debian11</image>
</from>
<to>
<image>metrics-processing-operator</image>
<image>operations-operator</image>
</to>
<container>
<jvmFlags>
Expand Down
0 ...cs/AbstractMetricsHandlingReconciler.java → ...cs/AbstractMetricsHandlingReconciler.java
View file
Open in desktop
File renamed without changes.
0 ...e/metrics/MetricsHandlingReconciler1.java → ...e/metrics/MetricsHandlingReconciler1.java
View file
Open in desktop
File renamed without changes.
0 ...e/metrics/MetricsHandlingReconciler2.java → ...e/metrics/MetricsHandlingReconciler2.java
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...etrics/MetricsHandlingSampleOperator.java → ...etrics/MetricsHandlingSampleOperator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ public static void main(String[] args) {

@Override
public Map<String, String> resourceAttributes() {
return Map.of("service.name", "josdk", "operator", "metrics-processing");
return Map.of("service.name", "josdk", "operator", "operations");
}
};

Expand Down
0 ...ource/MetricsHandlingCustomResource1.java → ...ource/MetricsHandlingCustomResource1.java
View file
Open in desktop
File renamed without changes.
0 ...ource/MetricsHandlingCustomResource2.java → ...ource/MetricsHandlingCustomResource2.java
View file
Open in desktop
File renamed without changes.
0 ...s/customresource/MetricsHandlingSpec.java → ...s/customresource/MetricsHandlingSpec.java
View file
Open in desktop
File renamed without changes.
0 ...customresource/MetricsHandlingStatus.java → ...customresource/MetricsHandlingStatus.java
View file
Open in desktop
File renamed without changes.
0 ...eratorsdk/operator/sample/deployment.yaml → ...eratorsdk/operator/sample/deployment.yaml
View file
Open in desktop
File renamed without changes.
0 ...-processing/src/main/resources/log4j2.xml → .../operations/src/main/resources/log4j2.xml
View file
Open in desktop
File renamed without changes.
0 ...ssing/src/main/resources/otlp-config.yaml → ...tions/src/main/resources/otlp-config.yaml
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...or/sample/metrics/MetricsHandlingE2E.java → ...or/sample/metrics/MetricsHandlingE2E.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ class MetricsHandlingE2E {
static final int OTEL_COLLECTOR_PORT = 4318;
public static final Duration TEST_DURATION = Duration.ofSeconds(60);
public static final String NAME_LABEL_KEY = "app.kubernetes.io/name";
static final String HELM_RELEASE_NAME = "metrics-processing";
static final String HELM_RELEASE_NAME = "operations";

private LocalPortForward prometheusPortForward;
private LocalPortForward otelCollectorPortForward;
Expand Down
6 changes: 3 additions & 3 deletions ...ssing/src/test/resources/helm-values.yaml → ...tions/src/test/resources/helm-values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@
# limitations under the License.
#

# Helm values for metrics-processing operator E2E test deployment
# Helm values for operations operator E2E test deployment
# Used with the generic-operator-chart from helm/generic-helm-chart/

image:
repository: metrics-processing-operator
repository: operations-operator
pullPolicy: Never
tag: "latest"

nameOverride: "metrics-processing-operator"
nameOverride: "operations-operator"

resources: {}

Expand Down
2 changes: 1 addition & 1 deletion sample-operators/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,6 @@
<module>mysql-schema</module>
<module>leader-election</module>
<module>controller-namespace-deletion</module>
<module>metrics-processing</module>
<module>operations</module>
Copy link

Copilot AI Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This changes the Maven reactor module to operations, but the PR diff still shows the sample’s POM and sources under sample-operators/metrics-processing/.... If the directory rename to sample-operators/operations isn’t included, the build will fail because Maven won’t find sample-operators/operations/pom.xml. Either rename/move the module directory (and adjust paths accordingly) or keep the module entry pointing to metrics-processing.

Suggested change
<module>operations</module>
<module>metrics-processing</module>

Copilot uses AI. Check for mistakes.
</modules>
</project>
Loading