-
Notifications
You must be signed in to change notification settings - Fork 5
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
Rahul/oct18/platformfeatures #720
Open
rahulagarwal13
wants to merge
8
commits into
main
Choose a base branch
from
rahul/oct18/platformfeatures
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+84
−0
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
600d0dd
comments edits
rahulagarwal13 5840e3e
Optimised images with calibre/image-actions
hasura-bot 0c96081
edits
rahulagarwal13 bf894a9
Merge changes from remote rahul/oct17/platformfeatures
rahulagarwal13 bf2c40f
dashboard
rahulagarwal13 b6d043f
Optimised images with calibre/image-actions
hasura-bot 42f5bc1
Merge branch 'main' into rahul/oct18/platformfeatures
robertjdominguez 2acee19
Docs Review
robertjdominguez File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
--- | ||
sidebar_position: 3 | ||
sidebar_label: Platform Dashboard | ||
description: | ||
"The Platform Dashboard is a comprehensive reporting tool designed to provide insights into the performance, security, | ||
and usage of the Data Delivery Netowork" | ||
keywords: | ||
- hasura ddn | ||
- metrics | ||
- performance | ||
- latency | ||
- request rate | ||
- error rate | ||
- graphql api | ||
- opentelemetry | ||
- application debugging | ||
- application performance | ||
- api monitoring | ||
- platform dashboard | ||
- dashboard | ||
- application management | ||
--- | ||
|
||
import Thumbnail from "@site/src/components/Thumbnail"; | ||
|
||
# Platform Dashboard | ||
|
||
Go to the `Platform Report` tab in the `Insights` panel for your project to view the new platform metrics. This | ||
dashboard provides a visual overview of key metrics across four main categories, offering a comprehensive assessment of | ||
the Data Delivery Network platform: | ||
|
||
## Security and Governance | ||
|
||
:::tip Available on | ||
|
||
Security and Governance reports are available on DDN Free plans and up. | ||
|
||
::: | ||
|
||
### Public Endpoint Alert | ||
|
||
Quickly identify any models that are publicly exposed without authentication. | ||
|
||
This feature helps prevent unauthorized access by providing clear notifications of potential vulnerabilities. By | ||
scanning your API endpoint for any publicly accessible models, you’ll be alerted if any part of your system is not | ||
secured, allowing you to take immediate action. | ||
|
||
### Security Issue Resolution | ||
|
||
A step-by-step guide to resolve detected security issues. | ||
|
||
This feature provides actionable insights on how to secure your supergraph, helping you implement necessary changes | ||
without guesswork. Each detected issue is paired with recommended fixes to improve the overall security of your API. | ||
|
||
<Thumbnail | ||
src="/img/get-started/dashboard_security.png" | ||
alt="The Security and Governance report showing that NoAuth mode makes the API publicly accessible" | ||
width="1000" | ||
/> | ||
|
||
## System Reliability (DDN Base) | ||
|
||
- System Reliability: Error/Success ratio | ||
- Team based analyis coming soon! | ||
|
||
<Thumbnail src="/img/get-started/dashboard_reliability.png" alt="x" width="1000" /> | ||
|
||
## API Usage Trends (DDN Base) | ||
|
||
Deprecated Features: List of deprecated objects. | ||
|
||
<Thumbnail src="/img/get-started/dashboard_usage.png" alt="x" width="1000" /> | ||
|
||
## Developer Productivity (DDN Advanced) | ||
|
||
Developer Count: Number of developers per team. | ||
|
||
<Thumbnail src="/img/get-started/dashboard_productivity.png" alt="x" width="1000" /> | ||
|
||
You can print the report out using the print icon on the top right | ||
|
||
<Thumbnail src="/img/get-started/dashboard_print.png" alt="x" width="1000" /> | ||
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@julian-mayorga and @rahulagarwal13 — please note what I did here to make things clearer. You can see more details of the step-by-step we need to replicate for the other subheadings in this commit's description.