Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documented logTiming key in 'config.json'. #86

Merged
merged 1 commit into from
May 28, 2024
Merged

Documented logTiming key in 'config.json'. #86

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/pages/getting-started/endpoints.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ To provide information about the provider, we will create a `config.json` file w
{
"coreProvider": ...,
"networkId": "preprod",
"logging": [{ "type": { "tag": "stderr" }, "severity": "Debug", "verbosity": "V2" }]
"logging": [{ "type": { "tag": "stderr" }, "severity": "Debug", "verbosity": "V2" }],
"logTiming": false
}
```

Expand Down Expand Up @@ -88,6 +89,7 @@ Here is the explanation for each of the JSON keys above:
* For Blockfrost, `blockfrostKey` holds the required api key.
* **`networkId`**: Specifies your network and must be one of `mainnet`, `preprod`, `preview`, `testnet` (for legacy testnet) & `privnet` (for local private network).
* **`logging`**: It's a list of [scribes](https://hackage.haskell.org/package/katip-0.8.7.3/docs/Katip.html#t:Scribe) to register. Its parameters (like `severity`, `verbosity`) and its general usage can be understood by going over their official haddock documentation [here](https://hackage.haskell.org/package/katip-0.8.7.2/docs/Katip.html). Katip is also explained in [this](https://link.springer.com/book/10.1007/978-1-4842-3739-7) book on web development in Haskell. Please have a look at haddock for `FromJSON` and `ToJSON` instances of [`GYLogScriptType`](https://haddock.atlas-app.io/GeniusYield-Types-Logging.html#t:GYLogScribeType) to see sample usage.
* **`logTiming`**: (Optional) If set to `true`, operations involving provider are timed and corresponding durations are logged.

### Parsing Given Configuration

Expand Down
Loading