Skip to content

Commit 2f22387

Browse files
committed
Update markdownlint-cli and observability headings
Closes #315
1 parent 02563df commit 2f22387

2 files changed

Lines changed: 6 additions & 4 deletions

File tree

practices/observability.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,8 @@ The [Site Reliability Workbook](https://landing.google.com/sre/workbook/chapters
179179

180180
The [SRE book](https://landing.google.com/sre/sre-book/chapters/monitoring-distributed-systems/) discusses two types of monitoring:
181181

182-
**Clear-box monitoring**<br/>
182+
### Clear-box monitoring
183+
183184
> Monitoring based on metrics exposed by the internals of the system, including logs, interfaces like the Java Virtual Machine Profiling Interface, or an HTTP handler that emits internal statistics.
184185
185186
Examples include:
@@ -189,7 +190,8 @@ Examples include:
189190
- Publishing internal metrics from a component as CloudWatch [custom metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html), either by pushing them to CloudWatch using the SDK or by using [metric filters](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/MonitoringLogData.html#search-filter-concepts) to extract metrics from application logs in [CloudWatch Logs](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html).
190191
- Using [Java Management Extensions](https://en.wikipedia.org/wiki/Java_Management_Extensions) (JMX) to collect internal metrics from an instrumented Java component.
191192

192-
**Opaque-box monitoring**<br/>
193+
### Opaque-box monitoring
194+
193195
> Testing externally-visible behaviour as a user would see it.
194196
195197
Examples include:

scripts/markdown-check-format.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@
1313

1414
files=$((git diff --diff-filter=ACMRT --name-only origin/${BRANCH_NAME:-main}.. "*.md"; git diff --name-only "*.md") | sort | uniq)
1515
if [ -n "$files" ]; then
16-
image=ghcr.io/igorshubovych/markdownlint-cli@sha256:df7ce7cdcdb525d52a89d7aab17c507d49adceaddf2b767d3ed799c9537ded80 # v0.32.2
16+
image=ghcr.io/igorshubovych/markdownlint-cli@sha256:905baf9f6bd11da2ede8c394882c616509385f24b8b8d54fff6e111be88f39de # v0.49.1
1717
docker run --rm \
1818
-v $PWD:/workdir \
1919
$image \
2020
$files \
21-
--disable MD013 MD033
21+
--disable MD013 MD033 MD055 MD056 MD058 MD059 MD060
2222
fi

0 commit comments

Comments
 (0)