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.

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
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
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
1 change: 1 addition & 0 deletions docs/getting-started/collaborate/comment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@ keeping them informed of any discussions or questions.

The notification hub can be found in the top right corner of the console. On clicking the comments button, you will see all the comments
where you are tagged in one place. The messages will be grouped based on the underlying commenting thread. You can click on a particular comment (deep linking) and go to the original thread on the console.

You can also delete notifications from that menu.

{/* <Thumbnail src="/img/get-started/comments_notification.png" alt="Alt text" width="100" height="100" /> */}
Expand Down
83 changes: 83 additions & 0 deletions docs/observability/platform-dashboard.mdx
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"
/>
Comment on lines +32 to +59
Copy link
Collaborator

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.


## 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" />

Binary file added static/img/get-started/dashboard_print.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/get-started/dashboard_productivity.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/get-started/dashboard_reliability.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/get-started/dashboard_security.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/get-started/dashboard_usage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading