doc: http metrics path normalization #4155

nelson-parente · 2024-05-21T17:27:37Z

Thank you for helping make the Dapr documentation better!

Please follow this checklist before submitting:

Commits are signed with Developer Certificate of Origin (DCO - learn more)
Read the contribution guide
Commands include options for Linux, MacOS, and Windows within codetabs
New file and folder names are globally unique
Page references use shortcodes instead of markdown or URL links
Images use HTML style and have alternative text
Places where multiple code/command options are given have codetabs

In addition, please fill out the following to help reviewers understand this pull request:

Description

Related code link:

dapr/proposals#58

Signed-off-by: nelson.parente <[email protected]>

github-actions · 2024-05-28T00:09:30Z

Stale PR, paging all reviewers

daprdocs/content/en/operations/observability/metrics/metrics-overview.md

github-actions · 2024-06-03T00:09:35Z

Stale PR, paging all reviewers

Signed-off-by: nelson.parente <[email protected]>

daprdocs/content/en/operations/configuration/configuration-overview.md

daprdocs/content/en/operations/observability/metrics/metrics-overview.md

Signed-off-by: nelson.parente <[email protected]>

github-actions · 2024-06-25T00:09:30Z

Stale PR, paging all reviewers

msfussell

Main feedback here is to provide a little more explanation on the examples. Also the default of true remains the same in v1.14 and so need to update this everywhere

daprdocs/content/en/operations/configuration/configuration-overview.md

daprdocs/content/en/operations/observability/metrics/metrics-overview.md

daprdocs/content/en/operations/configuration/configuration-overview.md

daprdocs/content/en/operations/observability/metrics/metrics-overview.md

Signed-off-by: nelson.parente <[email protected]>

JoshVanL · 2024-06-25T14:58:19Z

Please can we include in the documentation that there are security concerns with using the default high cardinality option whereby exposed Dapr enabled applications that call HTTP endpoints based on client input can cause unbounded cardinality in metrics resulting in DDoSing of the Dapr instance or cluster and/or larger metric ingestion bills.

Signed-off-by: nelson.parente <[email protected]>

hhunter-ms

quick edits

hhunter-ms · 2024-06-27T13:48:03Z

daprdocs/content/en/operations/configuration/configuration-overview.md

 ```

+In the examples above this path filter `/orders/{orderID}/items/{itemID}` would return a single metric count matching all the orderIDs and all the itemIDs rather than multiple metrics for each itemID. For more information see [HTTP metrics path matching]({{< ref "metrics-overview.md#http-metrics-path-matching" >}})


Suggested change

In the examples above this path filter `/orders/{orderID}/items/{itemID}` would return a single metric count matching all the orderIDs and all the itemIDs rather than multiple metrics for each itemID. For more information see [HTTP metrics path matching]({{< ref "metrics-overview.md#http-metrics-path-matching" >}})

In the examples above, the path filter `/orders/{orderID}/items/{itemID}` would return a single metric count matching all the `orderIDs` and all the `itemIDs`, rather than multiple metrics for each `itemID`. For more information, see [HTTP metrics path matching]({{< ref "metrics-overview.md#http-metrics-path-matching" >}}).

daprdocs/content/en/operations/configuration/configuration-overview.md

daprdocs/content/en/operations/observability/metrics/metrics-overview.md

Signed-off-by: nelson.parente <[email protected]>

nelson-parente · 2024-06-27T14:46:10Z

applied @hhunter-ms suggestions, ty! 👍

msfussell

These are now an amazing detailed set of docs! Thank you @nelson-parente !

* doc: http metrics path normalization Signed-off-by: nelson.parente <[email protected]> * doc: code review & path matching rename Signed-off-by: nelson.parente <[email protected]> * doc: add configuration examples Signed-off-by: nelson.parente <[email protected]> * update: update docs based on last proposal changes Signed-off-by: nelson.parente <[email protected]> * feat: more updates based on the ingress/egress merge Signed-off-by: nelson.parente <[email protected]> * doc: code review comments Signed-off-by: nelson.parente <[email protected]> * doc: code review comments Signed-off-by: nelson.parente <[email protected]> * feat: add excludeVerbs Signed-off-by: nelson.parente <[email protected]> * feat: new line Signed-off-by: nelson.parente <[email protected]> * feat: add review meeting changes Signed-off-by: nelson.parente <[email protected]> * feat: apply hunter suggestions Signed-off-by: nelson.parente <[email protected]> --------- Signed-off-by: nelson.parente <[email protected]> Signed-off-by: salaboy <[email protected]>

marcduiker · 2024-08-15T12:11:20Z

@holopin-bot @nelson-parente Thank you Nelson!

holopin-bot · 2024-08-15T12:11:23Z

Congratulations @nelson-parente, the maintainer of this repository has issued you a badge! Here it is: https://holopin.io/claim/clzv8p0pm145910clfsdiz7tmo

This badge can only be claimed by you, so make sure that your GitHub account is linked to your Holopin account. You can manage those preferences here: https://holopin.io/account.
Or if you're new to Holopin, you can simply sign up with GitHub, which will do the trick!

doc: http metrics path normalization

5ba4d75

Signed-off-by: nelson.parente <[email protected]>

hhunter-ms assigned nelson-parente May 22, 2024

github-actions bot added the stale label May 28, 2024

msfussell reviewed May 28, 2024

View reviewed changes

hhunter-ms removed the stale label May 28, 2024

github-actions bot added the stale label Jun 3, 2024

doc: code review & path matching rename

347c25c

Signed-off-by: nelson.parente <[email protected]>

nelson-parente force-pushed the feat/http-metrics-path-normalization branch from f51bd67 to 347c25c Compare June 5, 2024 09:55

msfussell added waiting-on-code-pr The code PR needs to be merged before the docs are updated and removed stale labels Jun 8, 2024

doc: add configuration examples

5fa8028

Signed-off-by: nelson.parente <[email protected]>

nelson-parente force-pushed the feat/http-metrics-path-normalization branch from eecfc0a to 5fa8028 Compare June 14, 2024 18:37

nelson-parente marked this pull request as ready for review June 17, 2024 09:20

nelson-parente requested review from a team as code owners June 17, 2024 09:20

Merge branch 'v1.13' into feat/http-metrics-path-normalization

1fd5592

artursouza requested changes Jun 17, 2024

View reviewed changes

daprdocs/content/en/operations/configuration/configuration-overview.md Show resolved Hide resolved

artursouza requested changes Jun 18, 2024

View reviewed changes

daprdocs/content/en/operations/observability/metrics/metrics-overview.md Outdated Show resolved Hide resolved

artursouza requested changes Jun 18, 2024

View reviewed changes

daprdocs/content/en/operations/observability/metrics/metrics-overview.md Outdated Show resolved Hide resolved

nelson-parente added 3 commits June 18, 2024 15:47

Merge branch 'v1.13' into feat/http-metrics-path-normalization

1fb84e5

update: update docs based on last proposal changes

bf52a1c

Signed-off-by: nelson.parente <[email protected]>

feat: more updates based on the ingress/egress merge

a548edd

Signed-off-by: nelson.parente <[email protected]>

nelson-parente requested review from artursouza and msfussell June 19, 2024 17:54

msfussell removed the waiting-on-code-pr The code PR needs to be merged before the docs are updated label Jun 19, 2024

github-actions bot added the stale label Jun 25, 2024

msfussell reviewed Jun 25, 2024

View reviewed changes

nelson-parente added 3 commits June 25, 2024 09:10

Merge branch 'v1.13' into feat/http-metrics-path-normalization

7cb14cc

doc: code review comments

981783a

Signed-off-by: nelson.parente <[email protected]>

doc: code review comments

9def806

Signed-off-by: nelson.parente <[email protected]>

hhunter-ms removed the stale label Jun 25, 2024

nelson-parente added 2 commits June 25, 2024 18:10

feat: add excludeVerbs

67aea73

Signed-off-by: nelson.parente <[email protected]>

feat: new line

eea7edc

Signed-off-by: nelson.parente <[email protected]>

nelson-parente force-pushed the feat/http-metrics-path-normalization branch from 29bda3d to eea7edc Compare June 25, 2024 17:16

feat: add review meeting changes

74c9461

Signed-off-by: nelson.parente <[email protected]>

nelson-parente requested a review from msfussell June 25, 2024 18:01

Merge branch 'v1.13' into feat/http-metrics-path-normalization

b5ee5fa

artursouza approved these changes Jun 27, 2024

View reviewed changes

hhunter-ms requested changes Jun 27, 2024

View reviewed changes

feat: apply hunter suggestions

efcd30e

Signed-off-by: nelson.parente <[email protected]>

nelson-parente requested review from hhunter-ms and artursouza June 27, 2024 14:46

hhunter-ms approved these changes Jun 27, 2024

View reviewed changes

msfussell approved these changes Jun 27, 2024

View reviewed changes

msfussell merged commit 57b85bf into dapr:v1.13 Jun 27, 2024
7 checks passed

hhunter-ms added this to the 1.14 milestone Jun 27, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: http metrics path normalization #4155

doc: http metrics path normalization #4155

nelson-parente commented May 21, 2024 •

edited by hhunter-ms

Loading

github-actions bot commented May 28, 2024

github-actions bot commented Jun 3, 2024

github-actions bot commented Jun 25, 2024

msfussell left a comment

JoshVanL commented Jun 25, 2024

hhunter-ms left a comment

hhunter-ms Jun 27, 2024

nelson-parente commented Jun 27, 2024

msfussell left a comment

marcduiker commented Aug 15, 2024

holopin-bot bot commented Aug 15, 2024

		```

		In the examples above this path filter `/orders/{orderID}/items/{itemID}` would return a single metric count matching all the orderIDs and all the itemIDs rather than multiple metrics for each itemID. For more information see [HTTP metrics path matching]({{< ref "metrics-overview.md#http-metrics-path-matching" >}})

	In the examples above this path filter `/orders/{orderID}/items/{itemID}` would return a single metric count matching all the orderIDs and all the itemIDs rather than multiple metrics for each itemID. For more information see [HTTP metrics path matching]({{< ref "metrics-overview.md#http-metrics-path-matching" >}})
	In the examples above, the path filter `/orders/{orderID}/items/{itemID}` would return a single metric count matching all the `orderIDs` and all the `itemIDs`, rather than multiple metrics for each `itemID`. For more information, see [HTTP metrics path matching]({{< ref "metrics-overview.md#http-metrics-path-matching" >}}).

doc: http metrics path normalization #4155

doc: http metrics path normalization #4155

Conversation

nelson-parente commented May 21, 2024 • edited by hhunter-ms Loading

Description

Related code link:

github-actions bot commented May 28, 2024

github-actions bot commented Jun 3, 2024

github-actions bot commented Jun 25, 2024

msfussell left a comment

Choose a reason for hiding this comment

JoshVanL commented Jun 25, 2024

hhunter-ms left a comment

Choose a reason for hiding this comment

hhunter-ms Jun 27, 2024

Choose a reason for hiding this comment

nelson-parente commented Jun 27, 2024

msfussell left a comment

Choose a reason for hiding this comment

marcduiker commented Aug 15, 2024

holopin-bot bot commented Aug 15, 2024

nelson-parente commented May 21, 2024 •

edited by hhunter-ms

Loading