-
Notifications
You must be signed in to change notification settings - Fork 7
feat: update cloud account docs #187
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
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
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 was deleted.
Oops, something went wrong.
This file contains hidden or 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,82 @@ | ||
| --- | ||
| title: "Cluster Observability" | ||
| sidebarTitle: "Cluster Observability" | ||
| description: "Monitor cluster health, resource usage, and infrastructure metrics" | ||
| --- | ||
|
|
||
| Porter provides built-in observability for your cluster infrastructure through the **Infrastructure** dashboard. Access it by clicking **Infrastructure** in the left sidebar. | ||
|
|
||
| --- | ||
|
|
||
| ## Pods | ||
|
|
||
| The **Pods** tab provides a real-time view of all pods running in your cluster. | ||
|
|
||
| - **Search**: Filter pods by name | ||
| - **Filters**: Filter by status or namespace | ||
|
|
||
| Each pod displays: | ||
|
|
||
| | Column | Description | | ||
| |--------|-------------| | ||
| | **Pod name** | The name of the pod | | ||
| | **Namespace** | Kubernetes namespace (e.g., `kube-system`, `default`) | | ||
| | **Status** | Current state (Running, Pending, Failed, etc.) | | ||
| | **Ready** | Container readiness (e.g., `1/1`) | | ||
| | **Restarts** | Number of container restarts | | ||
| | **CPU** | CPU usage | | ||
| | **Memory** | Memory usage | | ||
| | **Memory %** | Percentage of memory limit used | | ||
| | **Age** | Time since pod creation | | ||
|
|
||
| --- | ||
|
|
||
| ## Nodes | ||
|
|
||
| The **Nodes** tab shows your cluster's node groups and individual nodes. | ||
|
|
||
| ### Node Groups View | ||
|
|
||
| The default view displays all node groups: | ||
|
|
||
| | Column | Description | | ||
| |--------|-------------| | ||
| | **Node group** | Name of the node group (e.g., default, monitoring, system) | | ||
| | **Instance type** | The machine type for nodes in this group | | ||
| | **Utilization** | Visual indicator of resource usage | | ||
| | **Actions** | Link to view detailed metrics | | ||
|
|
||
| ### Individual Nodes View | ||
|
|
||
| Click on a node group to see individual nodes: | ||
|
|
||
| - **Node name**: The cloud provider's node identifier | ||
| - **Node group**: Which node group this node belongs to | ||
| - **Instance type**: The machine type | ||
| - **CPU**: CPU utilization shown as utilized (yellow) vs reserved (blue) | ||
| - **Memory**: Memory utilization shown as utilized (yellow) vs reserved (blue) | ||
| - **Status**: Node health status (Ready, NotReady) | ||
|
|
||
| Click **Metrics >** on any node group to view historical instance counts over time. | ||
|
|
||
| --- | ||
|
|
||
| ## Integrating External Monitoring | ||
|
|
||
| For application-level monitoring and alerting, integrate with external observability platforms: | ||
|
|
||
| <CardGroup cols={3}> | ||
| <Card title="Datadog" icon="dog" href="/observability/integrations"> | ||
| Full-stack monitoring with APM, logs, and infrastructure metrics | ||
| </Card> | ||
| <Card title="New Relic" icon="chart-line" href="/observability/integrations"> | ||
| Application performance monitoring and alerting | ||
| </Card> | ||
| <Card title="Grafana" icon="chart-area" href="/observability/integrations"> | ||
| Dashboards and visualization for metrics and logs | ||
| </Card> | ||
| </CardGroup> | ||
|
|
||
| See [Third party observability](/addons/third-party-observability) or reach out to support for more information. | ||
|
|
||
|
|
||
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.