Skip to content

Commit 0590d12

Browse files
authored
Update to markdownlint-cli2 (#2475)
1 parent d651fbb commit 0590d12

File tree

17 files changed

+332
-51
lines changed

17 files changed

+332
-51
lines changed
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# See https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
2+
# and https://github.com/DavidAnson/markdownlint-cli2
3+
4+
config:
5+
ul-style: false
6+
line-length: false
7+
no-duplicate-heading:
8+
siblings_only: true
9+
ol-prefix:
10+
style: ordered
11+
no-inline-html: false
12+
fenced-code-language: false
13+
no-trailing-punctuation:
14+
punctuation: ".,;:" # allowing exclamation points and question marks at end of sentences
15+
16+
ignores:
17+
- "**/build/**"
18+
- "**/node_modules/**"
19+
- "CHANGELOG.md"
20+
- "ibm-mq-metrics/docs/metrics.md"
21+
- ".github/pull_request_template.md"

.github/config/markdownlint.yml

Lines changed: 0 additions & 14 deletions
This file was deleted.

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,4 @@ When implementing changes or new features:
6363
1. Follow all [Style Guide](../docs/style-guide.md) conventions and the Code Review Priorities above
6464
2. Run tests to ensure they still pass (use `./gradlew test` and `./gradlew integrationTest` as needed)
6565
3. **Always run `./gradlew spotlessApply`** after making code changes to ensure proper formatting
66-
4. Run markdown lint to ensure it still passes: `npx markdownlint-cli@0.46.0 -c .github/config/markdownlint.yml **/*.md`
66+
4. Run markdown lint to ensure it still passes: `npx markdownlint-cli2@0.17.1 --config .github/config/.markdownlint-cli2.yaml "**/*.md"`

.github/repository-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ private admin repo.
2323
- `GPG_PASSWORD` - stored in OpenTelemetry-Java 1Password
2424
- `GPG_PRIVATE_KEY` - stored in OpenTelemetry-Java 1Password
2525
- `NVD_API_KEY` - stored in OpenTelemetry-Java 1Password
26-
- Generated at https://nvd.nist.gov/developers/request-an-api-key
26+
- Generated at <https://nvd.nist.gov/developers/request-an-api-key>
2727
- Key is associated with [@trask](https://github.com/trask)'s gmail address
2828
- `SONATYPE_KEY` - owned by [@trask](https://github.com/trask)
2929
- `SONATYPE_USER` - owned by [@trask](https://github.com/trask)

.github/workflows/reusable-markdown-lint.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ jobs:
1414

1515
- name: Run markdownlint
1616
run: |
17-
npx markdownlint-cli@0.46.0 -c .github/config/markdownlint.yml **/*.md
17+
npx markdownlint-cli2@0.17.1 --config .github/config/.markdownlint-cli2.yaml "**/*.md"

jmx-metrics/docs/target-systems/activemq.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,88 @@
11
# ActiveMQ Metrics
22

33
The JMX Metric Gatherer provides built in ActiveMQ metric gathering capabilities.
4-
These metrics are sourced from: https://activemq.apache.org/jmx
4+
These metrics are sourced from: <https://activemq.apache.org/jmx>
55

6-
### Metrics
6+
## Metrics
7+
8+
### activemq.consumer.count
79

810
* Name: `activemq.consumer.count`
911
* Description: The number of consumers currently reading from the broker.
1012
* Unit: `consumers`
1113
* Labels: `destination`
1214
* Instrument Type: ObservableLongUpDownCounter
1315

16+
### activemq.producer.count
1417

1518
* Name: `activemq.producer.count`
1619
* Description: The number of producers currently attached to the broker.
1720
* Unit: `producers`
1821
* Labels: `destination`
1922
* Instrument Type: ObservableLongUpDownCounter
2023

24+
### activemq.connectin.count
2125

2226
* Name: `activemq.connectin.count`
2327
* Description: The total number of current connections.
2428
* Unit: `connections`
2529
* Instrument Type: ObservableLongUpDownCounter
2630

31+
### activemq.memory.usage
2732

2833
* Name: `activemq.memory.usage`
2934
* Description: The percentage of configured memory used.
3035
* Unit: `%`
3136
* Labels: `destination`
3237
* Instrument Type: ObservableDoubleValue
3338

39+
### activemq.disk.store_usage
3440

3541
* Name: `activemq.disk.store_usage`
3642
* Description: The percentage of configured disk used for persistent messages.
3743
* Unit: `%`
3844
* Instrument Type: ObservableDoubleValue
3945

46+
### activemq.disk.temp_usage
4047

4148
* Name: `activemq.disk.temp_usage`
4249
* Description: The percentage of configured disk used for non-persistent messages.
4350
* Unit: `%`
4451
* Instrument Type: ObservableDoubleValue
4552

53+
### activemq.message.current
4654

4755
* Name: `activemq.message.current`
4856
* Description: The current number of messages waiting to be consumed.
4957
* Unit: `messages`
5058
* Labels: `destination`
5159
* Instrument Type: ObservableLongUpDownCounter
5260

61+
### activemq.message.expired
5362

5463
* Name: `activemq.message.expired`
5564
* Description: The total number of messages not delivered because they expired.
5665
* Unit: `messages`
5766
* Labels: `destination`
5867
* Instrument Type: ObservableLongCounter
5968

69+
### activemq.message.enqueued
6070

6171
* Name: `activemq.message.enqueued`
6272
* Description: The total number of messages received by the broker.
6373
* Unit: `messages`
6474
* Labels: `destination`
6575
* Instrument Type: ObservableLongCounter
6676

77+
### activemq.message.dequeued
6778

6879
* Name: `activemq.message.dequeued`
6980
* Description: The total number of messages delivered to consumers.
7081
* Unit: `messages`
7182
* Labels: `destination`
7283
* Instrument Type: ObservableLongCounter
7384

85+
### activemq.message.wait_time.avg
7486

7587
* Name: `activemq.message.wait_time.avg`
7688
* Description: The average time a message was held on a destination.

jmx-metrics/docs/target-systems/cassandra.md

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,93 +1,123 @@
11
# Casandra Metrics
22

33
The JMX Metric Gatherer provides built in Cassandra metric gathering capabilities.
4-
These metrics are sourced from Cassandra's exposed Dropwizard Metrics for each node: https://cassandra.apache.org/doc/latest/cassandra/managing/operating/metrics.html.
4+
These metrics are sourced from Cassandra's exposed Dropwizard Metrics for each node: <https://cassandra.apache.org/doc/latest/cassandra/managing/operating/metrics.html>.
55

6-
## Metrics
6+
## Client Request Metrics
77

8-
### Client Request Metrics
8+
### cassandra.client.request.range_slice.latency.50p
99

1010
* Name: `cassandra.client.request.range_slice.latency.50p`
1111
* Description: Token range read request latency - 50th percentile
1212
* Unit: `µs`
1313
* Instrument Type: DoubleValueObserver
1414

15+
### cassandra.client.request.range_slice.latency.99p
16+
1517
* Name: `cassandra.client.request.range_slice.latency.99p`
1618
* Description: Token range read request latency - 99th percentile
1719
* Unit: `µs`
1820
* Instrument Type: DoubleValueObserver
1921

22+
### cassandra.client.request.range_slice.latency.max
23+
2024
* Name: `cassandra.client.request.range_slice.latency.max`
2125
* Description: Maximum token range read request latency
2226
* Unit: `µs`
2327
* Instrument Type: DoubleValueObserver
2428

29+
### cassandra.client.request.read.latency.50p
30+
2531
* Name: `cassandra.client.request.read.latency.50p`
2632
* Description: Standard read request latency - 50th percentile
2733
* Unit: `µs`
2834
* Instrument Type: DoubleValueObserver
2935

36+
### cassandra.client.request.read.latency.99p
37+
3038
* Name: `cassandra.client.request.read.latency.99p`
3139
* Description: Standard read request latency - 99th percentile
3240
* Unit: `µs`
3341
* Instrument Type: DoubleValueObserver
3442

43+
### cassandra.client.request.read.latency.max
44+
3545
* Name: `cassandra.client.request.read.latency.max`
3646
* Description: Maximum standard read request latency
3747
* Unit: `µs`
3848
* Instrument Type: DoubleValueObserver
3949

50+
### cassandra.client.request.write.latency.50p
51+
4052
* Name: `cassandra.client.request.write.latency.50p`
4153
* Description: Regular write request latency - 50th percentile
4254
* Unit: `µs`
4355
* Instrument Type: DoubleValueObserver
4456

57+
### cassandra.client.request.write.latency.99p
58+
4559
* Name: `cassandra.client.request.write.latency.99p`
4660
* Description: Regular write request latency - 99th percentile
4761
* Unit: `µs`
4862
* Instrument Type: DoubleValueObserver
4963

64+
### cassandra.client.request.write.latency.max
65+
5066
* Name: `cassandra.client.request.write.latency.max`
5167
* Description: Maximum regular write request latency
5268
* Unit: `µs`
5369
* Instrument Type: DoubleValueObserver
5470

71+
### cassandra.client.request.count
72+
5573
* Name: `cassandra.client.request.count`
5674
* Description: Number of requests by operation
5775
* Labels: `operation`
5876
* Unit: `1`
5977
* Instrument Type: LongSumObserver
6078

79+
### cassandra.client.request.error.count
80+
6181
* Name: `cassandra.client.request.error.count`
6282
* Description: Number of request errors by operation
6383
* Labels: `operation`, `status`
6484
* Unit: `1`
6585
* Instrument Type: LongSumObserver
6686

67-
### Compaction Metrics
87+
## Compaction Metrics
88+
89+
### cassandra.compaction.tasks.completed
6890

6991
* Name: `cassandra.compaction.tasks.completed`
7092
* Description: Number of completed compactions since server [re]start
7193
* Unit: `1`
7294
* Instrument Type: LongSumObserver
7395

96+
### cassandra.compaction.tasks.pending
97+
7498
* Name: `cassandra.compaction.tasks.pending`
7599
* Description: Estimated number of compactions remaining to perform
76100
* Unit: `1`
77101
* Instrument Type: LongValueObserver
78102

79-
### Storage Metrics
103+
## Storage Metrics
104+
105+
### cassandra.storage.load.count
80106

81107
* Name: `cassandra.storage.load.count`
82108
* Description: Size of the on disk data size this node manages
83109
* Unit: `by`
84110
* Instrument Type: LongValueObserver
85111

112+
### cassandra.storage.total_hints.count
113+
86114
* Name: `cassandra.storage.total_hints.count`
87115
* Description: Number of hint messages written to this node since [re]start
88116
* Unit: `1`
89117
* Instrument Type: LongSumObserver
90118

119+
### cassandra.storage.total_hints.in_progress.count
120+
91121
* Name: `cassandra.storage.total_hints.in_progress.count`
92122
* Description: Number of hints attempting to be sent currently
93123
* Unit: `1`

jmx-metrics/docs/target-systems/hadoop.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,76 @@
11
# Hadoop Metrics
22

33
The JMX Metric Gatherer provides built in Hadoop metric gathering capabilities.
4-
These metrics are sourced from: https://hadoop.apache.org/docs/r2.7.2/hadoop-project-dist/hadoop-common/Metrics.html
4+
These metrics are sourced from: <https://hadoop.apache.org/docs/r2.7.2/hadoop-project-dist/hadoop-common/Metrics.html>
5+
6+
## Name Node Metrics
7+
8+
### hadoop.name_node.capacity.usage
59

6-
### Name Node Metrics
710
* Name: `hadoop.name_node.capacity.usage`
811
* Description: The current used capacity across all data nodes reporting to the name node.
912
* Unit: `by`
1013
* Labels: `node_name`
1114
* Instrument Type: LongUpDownCounterCallback
1215

16+
### hadoop.name_node.capacity.limit
17+
1318
* Name: `hadoop.name_node.capacity.limit`
1419
* Description: The total capacity allotted to data nodes reporting to the name node.
1520
* Unit: `by`
1621
* Labels: `node_name`
1722
* Instrument Type: LongUpDownCounterCallback
1823

24+
### hadoop.name_node.block.count
25+
1926
* Name: `hadoop.name_node.block.count`
2027
* Description: The total number of blocks on the name node.
2128
* Unit: `{blocks}`
2229
* Labels: `node_name`
2330
* Instrument Type: LongUpDownCounterCallback
2431

32+
### hadoop.name_node.block.missing
33+
2534
* Name: `hadoop.name_node.block.missing`
2635
* Description: The number of blocks reported as missing to the name node.
2736
* Unit: `{blocks}`
2837
* Labels: `node_name`
2938
* Instrument Type: LongUpDownCounterCallback
3039

40+
### hadoop.name_node.block.corrupt
41+
3142
* Name: `hadoop.name_node.block.corrupt`
3243
* Description: The number of blocks reported as corrupt to the name node.
3344
* Unit: `{blocks}`
3445
* Labels: `node_name`
3546
* Instrument Type: LongUpDownCounterCallback
3647

48+
### hadoop.name_node.volume.failed
49+
3750
* Name: `hadoop.name_node.volume.failed`
3851
* Description: The number of failed volumes reported to the name node.
3952
* Unit: `{volumes}`
4053
* Labels: `node_name`
4154
* Instrument Type: LongUpDownCounterCallback
4255

56+
### hadoop.name_node.file.count
57+
4358
* Name: `hadoop.name_node.file.count`
4459
* Description: The total number of files being tracked by the name node.
4560
* Unit: `{files}`
4661
* Labels: `node_name`
4762
* Instrument Type: LongUpDownCounterCallback
4863

64+
### hadoop.name_node.file.load
65+
4966
* Name: `hadoop.name_node.file.load`
5067
* Description: The current number of concurrent file accesses.
5168
* Unit: `{operations}`
5269
* Labels: `node_name`
5370
* Instrument Type: LongUpDownCounterCallback
5471

72+
### hadoop.name_node.data_node.count
73+
5574
* Name: `hadoop.name_node.data_node.count`
5675
* Description: The number of data nodes reporting to the name node.
5776
* Unit: `{nodes}`

0 commit comments

Comments
 (0)