Skip to content

spring boot samples - sdk metrics #480

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

Merged
tsurdilo merged 5 commits into from
Jun 20, 2023
Merged

spring boot samples - sdk metrics #480

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7ca2644
spring boot samples - sdk metrics
tsurdilo Jun 20, 2023
e16be24
spelling
tsurdilo Jun 20, 2023
01dab35
update
tsurdilo Jun 20, 2023
23601eb
fix numbering
tsurdilo Jun 20, 2023
7233a8e
update readme
tsurdilo Jun 20, 2023
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
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,4 +140,5 @@ See the README.md file in each main sample directory for cut/paste Gradle comman

More info on each sample:
- [**Hello**](/springboot/src/main/java/io/temporal/samples/springboot/hello): Invoke simple "Hello" workflow from a GET endpoint
- [**SDK Metrics**](/springboot/src/main/java/io/temporal/samples/springboot/metrics): Learn how to set up SDK Metrics

1 change: 1 addition & 0 deletions springboot/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ dependencies {
implementation "org.springframework.boot:spring-boot-starter-thymeleaf"
implementation "org.springframework.boot:spring-boot-starter-actuator"
implementation "io.temporal:temporal-spring-boot-starter-alpha:$javaSDKVersion"
runtimeOnly "io.micrometer:micrometer-registry-prometheus"
testImplementation "org.springframework.boot:spring-boot-starter-test"
dependencies {
errorproneJavac('com.google.errorprone:javac:9+181-r4173-1')
Expand Down
6 changes: 6 additions & 0 deletions springboot/src/main/java/io/temporal/samples/springboot/SamplesController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,10 @@ ResponseEntity helloSample(@RequestBody Person person) {
// bypass thymeleaf, don't return template name just result
return new ResponseEntity("\"" + workflow.sayHello(person) + "\"", HttpStatus.OK);
}

@GetMapping("/metrics")
public String metrics(Model model) {
model.addAttribute("sample", "SDK Metrics");
return "metrics";
}
}
13 changes: 13 additions & 0 deletions springboot/src/main/java/io/temporal/samples/springboot/metrics/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# SpringBoot Metrics Sample

1. Start SpringBoot from main samples repo directory:

./gradlew bootRun

2. In your browser navigate to:

http://localhost:3030/metrics

This sample involves just SpringBoot and Actuator configurations which are
included in the samples already. The page shows information on how to set up
SDK metrics in your SpringBoot applications.
10 changes: 9 additions & 1 deletion springboot/src/main/resources/application.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ server:
spring:
application:
name: temporal-samples
# temporal specific configs
temporal:
connection:
target: 127.0.0.1:7233
Expand All @@ -21,6 +22,13 @@ spring:
# max-threads: 10
workersAutoDiscovery:
packages: io.temporal.samples.springboot
# actuator (sdk metrics)
management:
endpoints:
web:
exposure:
include: prometheus
# specific for samples
samples:
data:
language: english
language: english
3 changes: 3 additions & 0 deletions springboot/src/main/resources/templates/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ <h5 class="card-title">Temporal Java SDK Samples</h5>
<div class="list-group">
<a href="/hello" class="list-group-item list-group-item-action">Say Hello</a>
</div>
<div class="list-group">
<a href="/metrics" class="list-group-item list-group-item-action">SDK Metrics</a>
</div>
</div>
</div>

Expand Down
86 changes: 86 additions & 0 deletions springboot/src/main/resources/templates/metrics.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org" xmlns="http://www.w3.org/1999/html">
<head>
<link rel="stylesheet"
href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.0/css/bootstrap.min.css"/>
<link rel="stylesheet"
href="https://cdnjs.cloudflare.com/ajax/libs/prism/9000.0.1/themes/prism.min.css"/>
<link href="https://fonts.googleapis.com/css2?family=Lato:ital,wght@1,400;1,700&display=swap" rel="stylesheet">
<script src="https://code.jquery.com/jquery-3.3.1.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.11.0/umd/popper.min.js"></script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.0/js/bootstrap.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/9000.0.1/prism.min.js"></script>
</head>
<body>
<div class="container">
<div class="card">
<div class="card-body">
<h4 class="card-title" th:text="'Temporal Java SDK Samples: ' + ${sample}">Temporal Java SDK Samples</h4>
<h6>In this sample we show how to set up and consume SDK metrics.</h6>
<br/><br/><br/>
<div>
<h6>Configuring SDK metrics is super easy using <a href="https://docs.spring.io/spring-boot/docs/current/reference/html/actuator.html" target="_blank">Spring Actuator</a></h6><br/>
<div class="list-group">
<a href="#" class="list-group-item list-group-item-action flex-column align-items-start">
<div class="d-flex w-100 justify-content-between">
<h5 class="mb-1">1. Add spring-boot-starter-actuator to project dependencies</h5>
</div>
<p class="mb-1">
<pre><code>Gradle:
<br/> implementation "org.springframework.boot:spring-boot-starter-actuator"
</code></pre>
<pre><code>Maven:
<br/> &lt;dependency&gt;
&lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;
&lt;artifactId&gt;spring-boot-starter-actuator&lt;/artifactId&gt;
&lt;/dependency&gt;
</code></pre>
</p>
</a>
<a href="#" class="list-group-item list-group-item-action flex-column align-items-start">
<div class="d-flex w-100 justify-content-between">
<h5 class="mb-1">2. Add micrometer-registry-prometheus as runtime dependency</h5>
</div>
<p class="mb-1">
<pre><code>Gradle:
<br/> runtimeOnly "io.micrometer:micrometer-registry-prometheus"
</code></pre>
<pre><code>Maven:
<br/> &lt;dependency&gt;
&lt;groupId>io.micrometer&lt;/groupId&gt;
&lt;artifactId>micrometer-registry-prometheus&lt;/artifactId&gt;
&lt;scope>runtime&lt;/scope&gt;
&lt;/dependency>
</code></pre>
</p>
</a>
<a href="#" class="list-group-item list-group-item-action flex-column align-items-start">
<div class="d-flex w-100 justify-content-between">
<h5 class="mb-1">3. Configure Actuator in application properties/yaml</h5>
</div>
<p class="mb-1">
<pre><code>management:
endpoints:
web:
exposure:
include: prometheus
</code></pre>
<small class="text-muted">Alternatively, you can define a custom io.micrometer.core.instrument.MeterRegistry bean in the application context.</small>
</a>
<a href="#" class="list-group-item list-group-item-action flex-column align-items-start">
<div class="d-flex w-100 justify-content-between">
<h5 class="mb-1">4. View metrics (Prometheus format)</h5>
</div>
<p>Actuator will expose SDK metrics automatically.<br/>
You can access raw metrics at "localhost:3030/actuator/prometheus".<br/>
This is already set up for the samples project.
</p>
<small class="text-muted">You can set up Prometheus config to scrape SDK metrics from this endpoint.</small>
</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>