Editing pass #331

Buzzardo · 2023-09-15T19:30:42Z

for consistency and readability.

See: micrometer-metrics/micrometer-docs#331 Co-authored-by: Jay Bryant <jbryant@vmware.com>

jonatan-ivanov · 2024-01-23T23:15:07Z

src/docs/concepts/gauges.adoc


 TIP: Gauges are useful for monitoring things with natural upper bounds. We do not recommend using a gauge to monitor things like request count, as they can grow without bound for the duration of an application instance's life.

 TIP: Never gauge something you can count with a `Counter`!

 Micrometer takes the stance that gauges should be sampled and not be set, so there is no information about what might have occurred between samples. Any intermediate values set on a gauge are lost by the time the gauge value is reported to a metrics backend, so there is little value in setting those intermediate values in the first place.

-Think of a `Gauge` as a "`heisen-gauge`": a meter that changes only when it is observed. Every other meter type accumulates intermediate counts toward the point where the data is sent to the metrics backend.
+Think of a `Gauge` as a "`heisenberg-gauge`": a meter that changes only when it is observed. Every other meter type accumulates intermediate counts toward the point where the data is sent to the metrics backend.


I think this was intentionally paraphrasing the word heisenbug, I would keep it as is unless this is problematic.

jonatan-ivanov · 2024-01-23T23:21:31Z

src/docs/concepts/implementations.adoc

@@ -20,9 +20,11 @@ Micrometer contains a core module with an instrumentation https://en.wikipedia.o
 |Server-side

 |AppOptics, Atlas, Azure Monitor, Datadog, Dynatrace, Elastic, Graphite, Ganglia, Humio, Influx, JMX, Kairos, New Relic, all StatsD flavors, SignalFx
-|Prometheus, Wavefront footnote:[As of 1.2.0, Micrometer sends cumulative values to Wavefront.]
+|Prometheus, Wavefront


footnote is a markdown feature and it places a footnote to the bottom with a link.

jonatan-ivanov · 2024-01-23T23:34:27Z

src/docs/concepts/timers.adoc


-The `micrometer-core` modules contains a `@Timed` annotation that frameworks can use to add timing support to either specific types of methods such as those serving web request endpoints or, more generally, to all methods.
+The `micrometer-core` modules contain a `@Timed` annotation that frameworks can use to add timing support to either specific types of methods such as those serving web request endpoints or, more generally, to all methods.


I think this should be:

The micrometer-core module contains

jonatan-ivanov · 2024-01-23T23:40:23Z

src/docs/implementations/appOptics.adoc

@@ -51,8 +51,8 @@ This section serves as a quick start to rendering useful representations in AppO
 The AppOptics implementation of `Timer` produces three fields in AppOptics:

 * `sum`: Rate of calls per second.
-* `count`: Rate of total time per second.
-* `max`: A sliding window maximum amount recorded.
+* `count`: Rate of total time (updated every second).


I think there are more issues here, sum is the rate of total time/sec while count is the rate of number of calls/sec.

jonatan-ivanov · 2024-01-23T23:43:50Z

src/docs/implementations/cloudwatch.adoc

@@ -8,7 +8,7 @@ https://aws.amazon.com/cloudwatch/[Amazon CloudWatch] is a dimensional time-seri

 include::install.adoc[]

-NOTE: The `micrometer-registry-cloudwatch2` module uses AWS SDK v2. `micrometer-registry-cloudwatch` is for AWS SDK v1.
+NOTE: The `micrometer-registry-cloudwatch2` module uses AWS SDK v2. `micrometer-registry-cloudwatch` is for version 1 of the AWS SDK.


The name of the component is AWS SDK v1, I think I would keep it that way.

jonatan-ivanov · 2024-01-24T00:26:16Z

src/docs/implementations/dynatrace.adoc

-Existing setups will continue to work when updating to newer versions of Micrometer.
-The reported metrics will be assigned to https://www.dynatrace.com/support/help/dynatrace-api/environment-api/topology-and-smartscape/custom-device-api/report-custom-device-metric-via-rest-api/[custom devices] in Dynatrace.
+Existing setups continue to work when updating to newer versions of Micrometer.
+The reported metrics are assigned to https://www.dynatrace.com/support/help/dynatrace-api/environment-api/topology-and-smartscape/Custom-Eevice-api/report-Custom-Eevice-metric-via-rest-api/[Custom Eevices] in Dynatrace.


The url change is not needed + "Custom Devices".

jonatan-ivanov · 2024-01-24T01:20:00Z

src/docs/implementations/humio.adoc

@@ -54,8 +54,8 @@ This section serves as a quick start to rendering useful representations in Humi
 The Humio implementation of `Timer` produces four fields in Humio:

 * `sum`: Rate of calls per second.
-* `count`: Rate of total time per second.
-* `max`: A sliding window maximum amount recorded.
+* `count`: Rate of total time (updated each second).


This has the same issue as AppOptics: sum is the rate of total time/sec while count is the rate of number of calls/sec.

jonatan-ivanov · 2024-01-24T01:56:17Z

src/docs/jetty/index.adoc

@@ -12,7 +12,7 @@ You can collect metrics from `Jetty` by adding `JettyConnectionMetrics` as follo

 Micrometer also supports binding metrics to `Jersey` through `ApplicationEventListener`.

-You can collect metrics from `Jersey` by adding `MetricsApplicationEventListener` as follows:


I think if we remove the code block from Jetty, we should remove it from Jersey too.

jonatan-ivanov · 2024-01-24T02:20:02Z

src/docs/observation/observation-instrumenting.adoc


 [[instrumentation_of_reactive_libraries_before_reactor_3_5_3]]
 === Before Reactor 3.5.3

-The preferred way of propagating elements through the Flux using Reactor is not via ``ThreadLocal``s but through Reactor Context. Reactor however gives you two operators, `tap()` and `handle()` where, if https://micrometer.io/docs/contextPropagation[Micrometer Context Propagation] library is on the classpath, it will set thread local values for you.
+The preferred way of propagating elements through the Flux by using Reactor is not through `ThreadLocal` instancess but through Reactor Context. Reactor, however, gives you two operators: `tap()` and `handle()`.With these two operators, if the https://micrometer.io/docs/contextPropagation[Micrometer Context Propagation] library is on the classpath, it sets the thread local values for you.


instances instead of instancess and missing space: ". With"

jonatan-ivanov · 2024-01-24T02:31:32Z

src/docs/observation/observation-projects.adoc

@@ -54,4 +54,4 @@ https://github.com/redisson/redisson/wiki/16.-Observability#162-tracing[Docs]
 | Spring WebFlux | https://docs.spring.io/spring-framework/reference/integration/observability.html[Docs]
 |===

-If your project is instrumented using Micrometer Observation, and it's not listed in the table above, https://github.com/micrometer-metrics/micrometer-docs/edit/main/src/docs/observation/observation-projects.adoc[please file a PR] to our documentation! If you want to instrument your project and need our help just mention us in your issue - https://github.com/shakuzen/[@shakuzen], https://github.com/jonatan-ivanov/[@jonatan-ivanov], https://github.com/marcingrzejszczak/[@marcingrzejszczak].
+If your project is instrumented witj Micrometer Observation and is not listed in the table, https://github.com/micrometer-metrics/micrometer-docs/edit/main/src/docs/observation/observation-projects.adoc[please file a PR] to our documentation! If you want to instrument your project and need our help, mention us in your issue - https://github.com/shakuzen/[@shakuzen], https://github.com/jonatan-ivanov/[@jonatan-ivanov], and https://github.com/marcingrzejszczak/[@marcingrzejszczak].


It seems editing pass from the old docs micrometer-metrics/micrometer-docs#331 were already migrated in gh-143

See micrometer-metrics/micrometer-docs#331 Co-authored-by: Jay Bryant <jbryant@vmware.com>

jonatan-ivanov · 2024-01-24T19:32:13Z

src/docs/contextpropagation/context-usage.adoc


 .ObservationThreadLocalAccessor
 [source,java,subs=+attributes]
 -----
 include::../../../samples/src/test/java/io/micrometer/docs/context/ObservationThreadLocalAccessor.java[tags=accessor,indent=0]
 -----

-Below you can find an example of how to store and restore thread local values via `ThreadLocalAccessor`, `ContextSnapshot` and `ContextRegistry`.
+The following example whows how to store and restore thread local values via `ThreadLocalAccessor`, `ContextSnapshot`, and `ContextRegistry`.


jonatan-ivanov · 2024-01-24T19:47:51Z

src/docs/observation/observation-docs-gen.adoc


 .build.gradle
 [source,groovy,subs=+attributes]
 -----
 include::../../../samples/src/test/resources/docs-generator-build.gradle[indent=0,tag=main]
 -----

-Running these tasks would lead to generation of adoc files similar to these ones.
+Running these tasks would lead to generation of adoc files similar to these :


Extra space before :

jonatan-ivanov · 2024-01-24T19:53:09Z

src/docs/observation/observation-docs-gen.adoc

-| Handlebars template file location. This can be a path in the classpath or file system.  +
-e.g.  `templates/metrics.adoc.hbs`, `/home/foo/bar.hbs`
+| Handlebars template file location. This can be a path in the classpath or file system,  +
+such as  `templates/metrics.adoc.hbs` or `/home/example/bar.hbs`


I'm gong to fix these extra spaces (after "such as").

jonatan-ivanov · 2024-01-24T20:02:59Z

src/docs/tracing/tracing-api.adoc


 [source,java,subs=+attributes]
 -----
 include::../../../samples/src/test/java/io/micrometer/docs/tracing/TracingApiTests.java[tags=manual_span_creation,indent=0]
 -----

-Below you can see how to continue a span in a new thread, that was started in another thread.
+The following example shows how to continue a span that was started in another thread in a new thread:


To me the previous version of the second part of this makes more sense:

The following example shows how to continue a span in a new thread that was started in another thread:

jonatan-ivanov · 2024-01-24T20:10:23Z

src/docs/tracing/tracing-configuring.adoc


 [source,java,subs=+attributes]
 -----
 include::../../../samples/src/test/java/io/micrometer/docs/tracing/TracingConfiguringTests.java[tags=handler_configuration,indent=0]
 -----

-You can also use a shorter version to perform measurements via the `observe` method.
+You can also use a shorter version to perform measurements by using the `observe` method"


: instead of "

See micrometer-metrics/micrometer-docs#331 Co-authored-by: Jay Bryant <jbryant@vmware.com>

jonatan-ivanov · 2024-01-24T20:30:18Z

I moved the changes in this PR:

My review can be ignored, I just recorded the changes I made.

Editing pass

764cfb9

for consistency and readability.

jonatan-ivanov added a commit to micrometer-metrics/micrometer that referenced this pull request Jan 24, 2024

Editing pass for consistency and readability

056373b

See: micrometer-metrics/micrometer-docs#331 Co-authored-by: Jay Bryant <jbryant@vmware.com>

jonatan-ivanov reviewed Jan 24, 2024

View reviewed changes

jonatan-ivanov closed this Jan 24, 2024

jonatan-ivanov added a commit to micrometer-metrics/context-propagation that referenced this pull request Jan 24, 2024

Editing pass

9d4d031

It seems editing pass from the old docs micrometer-metrics/micrometer-docs#331 were already migrated in gh-143

jonatan-ivanov added a commit to micrometer-metrics/micrometer-docs-generator that referenced this pull request Jan 24, 2024

Editing pass for consistency and readability

c283cec

See micrometer-metrics/micrometer-docs#331 Co-authored-by: Jay Bryant <jbryant@vmware.com>

jonatan-ivanov reviewed Jan 24, 2024

View reviewed changes

jonatan-ivanov added a commit to micrometer-metrics/tracing that referenced this pull request Jan 24, 2024

Editing pass for consistency and readability

e6d74bf

See micrometer-metrics/micrometer-docs#331 Co-authored-by: Jay Bryant <jbryant@vmware.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Editing pass #331

Editing pass #331

Buzzardo commented Sep 15, 2023

jonatan-ivanov Jan 23, 2024

jonatan-ivanov Jan 23, 2024

jonatan-ivanov Jan 23, 2024

jonatan-ivanov Jan 23, 2024

jonatan-ivanov Jan 23, 2024

jonatan-ivanov Jan 24, 2024

jonatan-ivanov Jan 24, 2024

jonatan-ivanov Jan 24, 2024

jonatan-ivanov Jan 24, 2024

jonatan-ivanov Jan 24, 2024

jonatan-ivanov Jan 24, 2024

jonatan-ivanov Jan 24, 2024

jonatan-ivanov Jan 24, 2024

jonatan-ivanov Jan 24, 2024

jonatan-ivanov Jan 24, 2024

jonatan-ivanov commented Jan 24, 2024


		The `micrometer-core` modules contains a `@Timed` annotation that frameworks can use to add timing support to either specific types of methods such as those serving web request endpoints or, more generally, to all methods.
		The `micrometer-core` modules contain a `@Timed` annotation that frameworks can use to add timing support to either specific types of methods such as those serving web request endpoints or, more generally, to all methods.

		@@ -12,7 +12,7 @@ You can collect metrics from `Jetty` by adding `JettyConnectionMetrics` as follo

		Micrometer also supports binding metrics to `Jersey` through `ApplicationEventListener`.

		You can collect metrics from `Jersey` by adding `MetricsApplicationEventListener` as follows:

Editing pass #331

Editing pass #331

Conversation

Buzzardo commented Sep 15, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jonatan-ivanov commented Jan 24, 2024