feat(java-sdk): support OpenTelemetry metrics

config/clients/java/config.overrides.json

@@ -12,6 +12,7 @@
   "utilPackage": "dev.openfga.sdk.util",
   "invokerPackage": "dev.openfga.sdk.api.client",
   "modelPackage": "dev.openfga.sdk.api.model",
+  "telemetryPackage": "dev.openfga.sdk.telemetry",
   "snapshotVersion": false,
   "packageDescription": "Java SDK for OpenFGA",
   "artifactDescription": "Java SDK for OpenFGA",
@@ -30,6 +31,7 @@
   "enumUnknownDefaultCase": true,
   "allowUnicodeIdentifiers": true,
   "caseInsensitiveResponseHeaders": true,
+  "supportsOpenTelemetry": true,
   "files": {
     "auth-model.json": {
       "destinationFilename": "src/test-integration/resources/auth-model.json",
@@ -343,6 +345,14 @@
       "destinationFilename": "src/main/java/dev/openfga/sdk/api/configuration/CredentialsMethod.java",
       "templateType": "SupportingFiles"
     },
+    "config-TelemetryConfiguration.java.mustache": {
+      "destinationFilename": "src/main/java/dev/openfga/sdk/api/configuration/TelemetryConfiguration.java",
+      "templateType": "SupportingFiles"
+    },
+    "config-TelemetryConfigurationTest.java.mustache": {
+      "destinationFilename": "src/test/java/dev/openfga/sdk/api/configuration/TelemetryConfigurationTest.java",
+      "templateType": "SupportingFiles"
+    },
     "errors-FgaApiAuthenticationError.java.mustache": {
       "destinationFilename": "src/main/java/dev/openfga/sdk/errors/FgaApiAuthenticationError.java",
       "templateType": "SupportingFiles"
@@ -395,6 +405,78 @@
       "destinationFilename": "src/main/java/dev/openfga/sdk/errors/ApiException.java",
       "templateType": "SupportingFiles"
     },
+    "telemetry-Attribute.java.mustache": {
+      "destinationFilename": "src/main/java/dev/openfga/sdk/telemetry/Attribute.java",
+      "templateType": "SupportingFiles"
+    },
+    "telemetry-AttributeTest.java.mustache": {
+      "destinationFilename": "src/test/java/dev/openfga/sdk/telemetry/AttributeTest.java",
+      "templateType": "SupportingFiles"
+    },
+    "telemetry-Attributes.java.mustache": {
+      "destinationFilename": "src/main/java/dev/openfga/sdk/telemetry/Attributes.java",
+      "templateType": "SupportingFiles"
+    },
+    "telemetry-AttributesTest.java.mustache": {
+      "destinationFilename": "src/test/java/dev/openfga/sdk/telemetry/AttributesTest.java",
+      "templateType": "SupportingFiles"
+    },
+    "telemetry-Counter.java.mustache": {
+      "destinationFilename": "src/main/java/dev/openfga/sdk/telemetry/Counter.java",
+      "templateType": "SupportingFiles"
+    },
+    "telemetry-CounterTest.java.mustache": {
+      "destinationFilename": "src/test/java/dev/openfga/sdk/telemetry/CounterTest.java",
+      "templateType": "SupportingFiles"
+    },
+    "telemetry-Counters.java.mustache": {
+      "destinationFilename": "src/main/java/dev/openfga/sdk/telemetry/Counters.java",
+      "templateType": "SupportingFiles"
+    },
+    "telemetry-CountersTest.java.mustache": {
+      "destinationFilename": "src/test/java/dev/openfga/sdk/telemetry/CountersTest.java",
+      "templateType": "SupportingFiles"
+    },
+    "telemetry-Histogram.java.mustache": {
+      "destinationFilename": "src/main/java/dev/openfga/sdk/telemetry/Histogram.java",
+      "templateType": "SupportingFiles"
+    },
+    "telemetry-HistogramTest.java.mustache": {
+      "destinationFilename": "src/test/java/dev/openfga/sdk/telemetry/HistogramTest.java",
+      "templateType": "SupportingFiles"
+    },
+    "telemetry-Histograms.java.mustache": {
+      "destinationFilename": "src/main/java/dev/openfga/sdk/telemetry/Histograms.java",
+      "templateType": "SupportingFiles"
+    },
+    "telemetry-HistogramsTest.java.mustache": {
+      "destinationFilename": "src/test/java/dev/openfga/sdk/telemetry/HistogramsTest.java",
+      "templateType": "SupportingFiles"
+    },
+    "telemetry-Metric.java.mustache": {
+      "destinationFilename": "src/main/java/dev/openfga/sdk/telemetry/Metric.java",
+      "templateType": "SupportingFiles"
+    },
+    "telemetry-MetricTest.java.mustache": {
+      "destinationFilename": "src/test/java/dev/openfga/sdk/telemetry/MetricTest.java",
+      "templateType": "SupportingFiles"
+    },
+    "telemetry-Metrics.java.mustache": {
+      "destinationFilename": "src/main/java/dev/openfga/sdk/telemetry/Metrics.java",
+      "templateType": "SupportingFiles"
+    },
+    "telemetry-MetricsTest.java.mustache": {
+      "destinationFilename": "src/test/java/dev/openfga/sdk/telemetry/MetricsTest.java",
+      "templateType": "SupportingFiles"
+    },
+    "telemetry-Telemetry.java.mustache": {
+      "destinationFilename": "src/main/java/dev/openfga/sdk/telemetry/Telemetry.java",
+      "templateType": "SupportingFiles"
+    },
+    "telemetry-TelemetryTest.java.mustache": {
+      "destinationFilename": "src/test/java/dev/openfga/sdk/telemetry/TelemetryTest.java",
+      "templateType": "SupportingFiles"
+    },
     "OpenFgaApiTest.java.mustache": {
       "destinationFilename": "src/test/java/dev/openfga/sdk/api/OpenFgaApiTest.java",
       "templateType": "SupportingFiles"
@@ -411,6 +493,10 @@
       "destinationFilename": "gradle/wrapper/gradle-wrapper.properties",
       "templateType": "SupportingFiles"
     },
+    "docs/OpenTelemetry.md.mustache": {
+      "destinationFilename": "docs/OpenTelemetry.md",
+      "templateType": "SupportingFiles"
+    },
     "example/Makefile": {
       "destinationFilename": "example/Makefile",
       "templateType": "SupportingFiles"
@@ -435,7 +521,7 @@
       "destinationFilename": "example/example1/gradlew",
       "templateType": "SupportingFiles"
     },
-    "example/example1/build.gradle": {
+    "example/example1/build.gradle.mustache": {
       "destinationFilename": "example/example1/build.gradle",
       "templateType": "SupportingFiles"
     },

config/clients/java/template/.github/dependabot.yaml

@@ -8,6 +8,14 @@ updates:
      dependencies:
         patterns:
           - "*"
+  - package-ecosystem: "gradle"
+    directory: "/example/example1"
+    schedule:
+      interval: "monthly"
+    groups:
+     dependencies:
+        patterns:
+          - "*"
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:

config/clients/java/template/.github/workflows/fossa.yaml

@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
 
       - name: Set up JDK 17
-        uses: actions/setup-java@99b8673ff64fbf99d8d325f52d9a5bdedb8483e9 # v4.2.1
+        uses: actions/setup-java@6a0805fcefea3d4657a47ac4c165951e33482018 # v4.2.2
         with:
           java-version: "17"
           distribution: "temurin"

config/clients/java/template/.github/workflows/main.yaml.mustache

@@ -17,25 +17,25 @@ jobs:
         java: [11, 17, 21]
 
     steps:
-      - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
 
       - name: Set up JDK
-        uses: actions/setup-java@99b8673ff64fbf99d8d325f52d9a5bdedb8483e9 # v4.2.1
+        uses: actions/setup-java@6a0805fcefea3d4657a47ac4c165951e33482018 # v4.2.2
         with:
           java-version: ${{ matrix.java }}
           distribution: "temurin"
           cache: gradle
 
       - name: Set up Gradle
-        uses: gradle/actions/setup-gradle@db19848a5fa7950289d3668fb053140cf3028d43 # v3.3.2
+        uses: gradle/actions/setup-gradle@dbbdc275be76ac10734476cc723d82dfe7ec6eda # v3.4.2
 
       - name: Test and Build with Gradle
         run: |
           ./gradlew build test-integration
 
       - if: matrix.java == 11
         name: Upload coverage to Codecov
-        uses: codecov/codecov-action@125fc84a9a348dbcf27191600683ec096ec9021c # v4.4.1
+        uses: codecov/codecov-action@e28ff129e5465c2c0dcc6f003fc735cb6ae0c673 # v4.5.0
         continue-on-error: true
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
@@ -51,19 +51,19 @@ jobs:
       packages: write
 
     steps:
-      - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
 
       - name: Set up JDK
-        uses: actions/setup-java@99b8673ff64fbf99d8d325f52d9a5bdedb8483e9 # v4.2.1
+        uses: actions/setup-java@6a0805fcefea3d4657a47ac4c165951e33482018 # v4.2.2
         with:
           java-version: 11
           distribution: "temurin"
 
       - name: Validate Gradle wrapper
-        uses: gradle/actions/wrapper-validation@db19848a5fa7950289d3668fb053140cf3028d43 # v3.3.2
+        uses: gradle/actions/wrapper-validation@dbbdc275be76ac10734476cc723d82dfe7ec6eda # v3.4.2
 
       - name: Setup Gradle
-        uses: gradle/actions/setup-gradle@db19848a5fa7950289d3668fb053140cf3028d43 # v3.3.2
+        uses: gradle/actions/setup-gradle@dbbdc275be76ac10734476cc723d82dfe7ec6eda # v3.4.2
 
         # Tasks created by https://github.com/gradle-nexus/publish-plugin
       - name: Publish package
@@ -84,19 +84,19 @@ jobs:
       packages: write
 
     steps:
-      - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
 
       - name: Set up JDK
-        uses: actions/setup-java@99b8673ff64fbf99d8d325f52d9a5bdedb8483e9 # v4.2.1
+        uses: actions/setup-java@6a0805fcefea3d4657a47ac4c165951e33482018 # v4.2.2
         with:
           java-version: 11
           distribution: "temurin"
 
       - name: Validate Gradle wrapper
-        uses: gradle/actions/wrapper-validation@db19848a5fa7950289d3668fb053140cf3028d43 # v3.3.2
+        uses: gradle/actions/wrapper-validation@dbbdc275be76ac10734476cc723d82dfe7ec6eda # v3.4.2
 
       - name: Setup Gradle
-        uses: gradle/actions/setup-gradle@db19848a5fa7950289d3668fb053140cf3028d43 # v3.3.2
+        uses: gradle/actions/setup-gradle@dbbdc275be76ac10734476cc723d82dfe7ec6eda # v3.4.2
 
       # Tasks created by https://docs.gradle.org/current/userguide/publishing_maven.html
       - name: Publish package
@@ -112,7 +112,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
 
       - uses: Roang-zero1/github-create-release-action@57eb9bdce7a964e48788b9e78b5ac766cb684803 # v3.0.1
         with:

config/clients/java/template/OpenFgaApiTest.java.mustache

@@ -1318,7 +1318,6 @@ public class OpenFgaApiTest {
         var response = fga.check(DEFAULT_STORE_ID, request).get();
 
         // Then
-        verify(mockConfiguration).getApiUrl();
         verify(mockConfiguration).getReadTimeout();
         mockHttpClient.verify().post(postPath).withBody(is(expectedBody)).called(1);
         assertNotNull(response.getData());

config/clients/java/template/build.gradle.mustache

@@ -61,8 +61,8 @@ ext {
     {{#swagger2AnnotationLibrary}}
     swagger_annotations_version = "2.2.9"
     {{/swagger2AnnotationLibrary}}
-    jackson_version = "2.17.1"
-    junit_version = "5.10.2"
+    jackson_version = "2.17.2"
+    junit_version = "5.10.3"
     {{#hasFormParamsInSpec}}
     httpmime_version = "4.5.13"
     {{/hasFormParamsInSpec}}
@@ -75,12 +75,14 @@ dependencies {
     {{#swagger2AnnotationLibrary}}
     implementation "io.swagger.core.v3:swagger-annotations:$swagger_annotations_version"
     {{/swagger2AnnotationLibrary}}
-    implementation "com.google.code.findbugs:jsr305:3.0.2"
+    implementation "com.google.code.findbugs:jsr305:3.0.+"
     implementation "com.fasterxml.jackson.core:jackson-core:$jackson_version"
     implementation "com.fasterxml.jackson.core:jackson-annotations:$jackson_version"
     implementation "com.fasterxml.jackson.core:jackson-databind:$jackson_version"
     implementation "com.fasterxml.jackson.datatype:jackson-datatype-jsr310:$jackson_version"
-    implementation "org.openapitools:jackson-databind-nullable:0.2.6"
+    implementation "org.openapitools:jackson-databind-nullable:0.2.+"
+    implementation platform("io.opentelemetry:opentelemetry-bom:1.41.+")
+    implementation "io.opentelemetry:opentelemetry-api"
     {{#hasFormParamsInSpec}}
     implementation "org.apache.httpcomponents:httpmime:$httpmime_version"
     {{/hasFormParamsInSpec}}
@@ -96,7 +98,7 @@ testing {
                 implementation "org.junit.jupiter:junit-jupiter:$junit_version"
                 implementation "org.mockito:mockito-core:5.+"
                 runtimeOnly "org.junit.platform:junit-platform-launcher"
-                implementation "org.wiremock:wiremock:3.6.0"
+                implementation "org.wiremock:wiremock:3.9.+"
 
                 // This test-only dependency is convenient but not widely used.
                 // Review project activity before updating the version here.
@@ -122,8 +124,8 @@ testing {
             dependencies {
                 implementation "com.fasterxml.jackson.core:jackson-core:$jackson_version"
                 implementation "com.fasterxml.jackson.core:jackson-databind:$jackson_version"
-                implementation "org.testcontainers:junit-jupiter:1.19.8"
-                implementation "org.testcontainers:openfga:1.19.8"
+                implementation "org.testcontainers:junit-jupiter:1.20.+"
+                implementation "org.testcontainers:openfga:1.20.+"
                 implementation project()
             }