8000 Add rfq grafana dashboard and fix links by trajan0x · Pull Request #2634 · synapsecns/sanguine · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add rfq gr 8000 afana dashboard and fix links #2634

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.

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

Merged
merged 1 commit into from
May 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 4 additions & 2 deletions docs/bridge/docs/rfq/Relayer/Relayer.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ The relayer is configured with a yaml file. The following is an example configur
- `type` - the database driver to use, can be `mysql` or `sqlite`.
- `dsn` - the dsn of your database. If using sqlite, this can be a path, if using mysql please see [here](https://dev.mysql.com/doc/connector-odbc/en/connector-odbc-configuration.html) for more information.
- `screener_api_url` (optional) - Please see [here](https://github.com/synapsecns/sanguine/tree/master/contrib/screener-api#screening-api) for an api spec, this is used descision on wether to bridge to given addresses.
- `rfq_url` - URL of the rfq api, please see the [API](../../API#API Urls) page for details and the mainnet/testnet urls.
- `rfq_url` - URL of the rfq api, please see the [API](../API#api-urls) page for details and the mainnet/testnet urls.
Copy link
Contributor

Choose a reason for hiding this comment

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

Fix the link to the API page.

The link to the API page should be [../API#api-urls] instead of [../../API#API Urls].

- rfq_url: 'http://rfq-api' # url of the rfq api backend.
+ rfq_url: 'http://rfq-api' # URL of the RFQ API backend. Please see the [API](../API#api-urls) page for details and the mainnet/testnet URLs.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
- `rfq_url` - URL of the rfq api, please see the [API](../API#api-urls) page for details and the mainnet/testnet urls.
- `rfq_url` - URL of the RFQ API backend. Please see the [API](../API#api-urls) page for details and the mainnet/testnet URLs.

- `omnirpc_url` - URL of omnirpc to use, Please see [here](../../Services/Omnirpc) for details on running an omnirpc instance.
- `rebalance_interval` - How often to rebalance, formatted as (s = seconds, m = minutes, h = hours)
- `relayer_api_port` - the relayer api is used to control the relayer. <!--TODO: more info here--> This api should be secured/not public.
Expand Down Expand Up @@ -221,4 +221,6 @@ The relayer is configured with a yaml file. The following is an example configur

### Observability

The RFQ relayer implements open telemetry for both tracing and metrics. Please see the [Observability](../../Observability) page for more info.
The RFQ relayer implements open telemetry for both tracing and metrics. Please see the [Observability](../../Observability) page for more info. There is also a custom [grafana dashboard](https://github.com/synapsecns/sanguine/tree/master/services/rfq/relayer/dashboards/grafana.json) available for the relayer.

![Relayer Grafana Dashboard](dashboard.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

Add a blank line before the image.

A blank line is needed before the image for proper formatting.

+ 
![Relayer Grafana Dashboard](dashboard.png)

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
![Relayer Grafana Dashboard](dashboard.png)
![Relayer Grafana Dashboard](dashboard.png)

Binary file added docs/bridge/docs/rfq/Relayer/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading
0