Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Vitaliy Skrypnyk committed Dec 5, 2021
1 parent 4caab76 commit dc12dd3
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 21 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
[comment]: <> ([![Forks][forks-shield]][forks-url])
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![Apache 2.0 License][license-shield]][license-url]

[comment]: <> ([![LinkedIn][linkedin-shield]][linkedin-url])

Expand Down Expand Up @@ -137,11 +137,11 @@ Distributed under the Apache License Version 2.0 License. See `LICENSE.md` for m

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[stars-shield]: https://img.shields.io/github/stars/github_username/repo_name.svg?style=for-the-badge
[stars-shield]: https://img.shields.io/github/stars/vitaliy-sk/PerfUnit.svg?style=for-the-badge
[stars-url]: https://github.com/vitaliy-sk/perfunit/stargazers
[issues-shield]: https://img.shields.io/github/issues/github_username/repo_name.svg?style=for-the-badge
[issues-shield]: https://img.shields.io/github/issues/vitaliy-sk/PerfUnit.svg?style=for-the-badge
[issues-url]: https://github.com/vitaliy-sk/perfunit/issues
[license-shield]: https://img.shields.io/github/license/github_username/repo_name.svg?style=for-the-badge
[license-url]: https://github.com/vitaliy-sk/perfunit/blob/master/LICENSE.txt
[license-shield]: https://img.shields.io/github/license/vitaliy-sk/PerfUnit.svg?style=for-the-badge
[license-url]: https://github.com/vitaliy-sk/perfunit/blob/master/LICENSE.md

----
32 changes: 16 additions & 16 deletions src/test/resources/config-sample.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,23 @@ rules:
# dev.techh.perfunit.integration.service.ExpensiveService - set shared limit to all methods' in the specified class
# dev.techh.perfunit.integration.service.ExpensiveService#testWithArgs - set shared limit to all methods with name testWithArgs
# dev.techh.perfunit.integration.service.ExpensiveService#testWithArgs(java.lang.String) - set limit testWithArgs with one String argument
dev.techh.perfunit.integration.service.ExpensiveService#count5InvocationsAllowed:
description: Method testNoArgs call to often # Optional: text description
allowUnknownCalls: true # Optional: allow invocation without tracing id (default: true)
allowFail: true # Optional: if "fail" and quota will be reach exception will be thrown (default: false)
tracingKey: traceId # Optional: key which be used for tracking quota usage. This key should be present in MDC (default: traceId)
onlyPublic: true # Optional: instrument only public methods (default: true)
limit:
# One or multiple limit can be used at the same time.
count: 10 # Numbers of call allowed
timeSingle: 200 # Single call limit in msec
timeTotal: 500 # Total time limit in msec

# dev.techh.perfunit.integration.service.ExpensiveService#count5InvocationsAllowed:
# description: count5InvocationsAllowed
# tracingKey: traceId
# limit:
# count: 5
# description: Method testNoArgs call to often # Optional: text description
# allowUnknownCalls: true # Optional: allow invocation without tracing id (default: true)
# allowFail: true # Optional: if "fail" and quota will be reach exception will be thrown (default: false)
# tracingKey: traceId # Optional: key which be used for tracking quota usage. This key should be present in MDC (default: traceId)
# onlyPublic: true # Optional: instrument only public methods (default: true)
# limit:
# # One or multiple limit can be used at the same time.
# count: 10 # Numbers of call allowed
# timeSingle: 200 # Single call limit in msec
# timeTotal: 500 # Total time limit in msec

dev.techh.perfunit.integration.service.ExpensiveService#count5InvocationsAllowed:
description: count5InvocationsAllowed
tracingKey: traceId
limit:
count: 5

dev.techh.perfunit.integration.service.ExpensiveService#time10MsecSingleAllowed:
description: time10MsecSingleAllowed
Expand Down

0 comments on commit dc12dd3

Please sign in to comment.