Skip to content

update usage documentation#100

Open
tobslob wants to merge 6 commits intomasterfrom
chore/doc-update
Open

update usage documentation#100
tobslob wants to merge 6 commits intomasterfrom
chore/doc-update

Conversation

@tobslob
Copy link
Contributor

@tobslob tobslob commented Jun 30, 2021

Changes

  • add metrics and env usage to READMe

@tobslob tobslob requested a review from noxecane June 30, 2021 02:58
Copy link
Contributor

@noxecane noxecane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For SiberMetrics

There's no pointer to the existing use of SiberMetrics in siber

For autoloadEnv

It would be better to separate the process for using autoloadEnv from the explanation of existing env schemas and types

@tobslob tobslob requested a review from noxecane July 7, 2021 08:36
Copy link
Contributor

@noxecane noxecane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

expecting fixes as discussed

@tobslob tobslob requested a review from allengblack July 16, 2021 03:08
README.md Outdated

## What is SiberMetrics and how it works.

SiberMetrics are routers around prometheus client for node.js to record and export a histogram of an http request.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Routers or "wrappers"?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Capitalise Prometheus, NodeJS.

})
```

## What is SiberMetrics and how it works.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not quite a "histogram of an HTTP request".
https://prometheus.io/docs/introduction/overview/

@tobslob tobslob requested a review from allengblack July 19, 2021 11:37
* @param schema schema to use for validation
*/
export function autoloadEnv<T extends AppConfig>(schema: ObjectSchema): T {
export function autoloadEnv<T>(schema: ObjectSchema): T {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you change these?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants