Add docs for version 2.0 #100
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Removed overly verbose issue and pr templates - Removed documentation from README - Readme now links to spi documentation page - Added docc documentation - Removed last usages of `TimeHistogram`
FranzBusch
approved these changes
Sep 21, 2023
|
|
||
| ## Installation | ||
|
|
||
| ``Prometheus`` is available through Swift Package Manager. To include it in your project add the |
There was a problem hiding this comment.
Suggested change
| ``Prometheus`` is available through Swift Package Manager. To include it in your project add the | |
| ``Prometheus`` is available through the Swift Package Manager. To include it in your project add the |
There was a problem hiding this comment.
Not sure "the" is needed here.
|
|
||
| The same functionality is also available for ``ValueHistogram`` and aggregating `Recorder`s. | ||
|
|
||
| [Swift Metrics]: https://github.com/apple/swift-metrics |
There was a problem hiding this comment.
Why this link here at the bottom?
There was a problem hiding this comment.
this is a markdown feature that allows you to have all the links in the end of your doc. this way the links don't polute the markdown reading experience inline.
Co-authored-by: Franz Busch <[email protected]>
| /// A closure to modify the name and labels used in the Swift Metrics API. This allows users | ||
| /// to overwrite the Metric names in third party packages. | ||
| public var labelAndDimensionSanitizer: @Sendable (_ label: String, _ dimensions: [(String, String)]) -> (String, [(String, String)]) | ||
| public var nameAndLabelSanitizer: @Sendable (_ label: String, _ dimensions: [(String, String)]) -> (String, [(String, String)]) |
There was a problem hiding this comment.
the var is called nameAndLabelSanitizer but the parameters are label, dimensions
this is maybe inconsistent
There was a problem hiding this comment.
this is a bit confusing re Prometheus and Swift Metrics naming.
Swift Metrics -> Prometheus
label -> name
dimensions -> labels
| myGauge.decrement() | ||
| ``` | ||
|
|
||
| Lastly, you can use your ``PrometheusCollectorRegistry`` to generate a Prometheus export as in the |
There was a problem hiding this comment.
not sure what 'as in' means here
fabianfett
commented
Sep 22, 2023
Co-authored-by: hamzahrmalik <[email protected]>
fabianfett
commented
Sep 22, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
TimeHistogram