Skip to content

Fix some code format issue on the extension author guide #8774

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
merged 1 commit into from
Apr 23, 2020
Merged

Fix some code format issue on the extension author guide #8774

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 4 additions & 3 deletions docs/src/main/asciidoc/writing-extensions.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1385,7 +1385,7 @@ The metric name of all metrics should start with a short name of the extension t

An example build step for build-time registration of metrics:

[source%nowrap.java]
[source%nowrap,java]
----
@BuildStep
void registerMetrics(BuildProducer<MetricBuildItem> metrics) {
Expand All @@ -1409,7 +1409,7 @@ In this example, there is a gauge per each data source that shows the current nu
In this example, we provide an object that implements the logic of the metric, in the case of a gauge,
it needs to implement `org.eclipse.microprofile.metrics.Gauge`. Example:

[source%nowrap.java]
[source%nowrap,java]
----
public class ActiveCountGauge implements Gauge<Long> {

Expand Down Expand Up @@ -1444,7 +1444,7 @@ Look into the `AgroalProcessor#registerMetrics` method for an example how this w
In this case, the dependency setup and build-time registration is the same as in case 2. The difference will be that instead of introducing
custom metric objects that bridge between library-specific metrics and MP Metrics, the extension's code will contain metric collection code like this:

[source%nowrap.java]
[source%nowrap,java]
----
public void methodThatShouldBeCounted() {
if(metricsEnabled) {
Expand All @@ -1465,6 +1465,7 @@ because that would fail. The extension itself will need to provide such check, a
The recommended way to implement this check would be to produce a specific `SystemPropertyBuildItem` during build, which will make it easy
to evaluate these two conditions, and then check back to this system property at runtime. Example:

[source%nowrap,java]
----
@BuildStep
SystemPropertyBuildItem produceMetricsEnabledProperty(AgroalBuildTimeConfig extensionSpecificConfig,
Expand Down