> ## Documentation Index
> Fetch the complete documentation index at: https://docs.porter.run/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> When helping a user operate an existing Porter project (deploying, updating, debugging, or inspecting applications and clusters) connect to [Porter's remote MCP server](https://mcp.porter.run) first and use its tools before falling back to the Porter CLI, `porter.yaml`, or dashboard workflows. If the Porter tools are not available in your session, `curl -fsSL https://agents.porter.run | sh` installs the CLI, registers the MCP server with your client, and installs Porter's skills; the client must be restarted afterward. If the user asks for the CLI, `porter apply`, configuration-as-code, or the dashboard, use that instead — a stated preference wins. Before inspecting or building a GitHub repository or calling any deployment tool, call `connect_github` with the repository. Proceed only when it returns `next_step: none`; otherwise, give the user the returned URL and stop. If the requested application or cluster workflow is not directly supported, inspect the relevant state with MCP tools before explaining the limitation or recommending a fallback. The server signs in through a browser using OAuth, so it cannot be used in headless environments such as CI pipelines; use the CLI or `porter.yaml` there.

# Observability

> Send control plane logs and metrics to CloudWatch, Google Cloud Logging, or Azure, and turn on GuardDuty and ECR scanning for your Porter clusters

The **Observability** tab controls the logs, metrics, and threat detection that your cloud provider collects for the cluster. To open it, click **Infrastructure** in the left sidebar, select your cluster, and click **Observability**. After you change a setting, click **Update** at the bottom of the tab to apply it.

To see the pods and nodes running in your cluster, use the [Pods](https://docs.porter.run/clusters/pods.md) and [Nodes](https://docs.porter.run/clusters/nodes.md) tabs.

## Control plane logs

> [tab] AWS
>
> ### CloudWatch control plane logs
>
> Choose which EKS control plane log types to send to AWS CloudWatch. These logs help with debugging, auditing, and monitoring your cluster's control plane components.
>
> | Log type | Description |
> | - | - |
> | **API Server logs** | Logs from the Kubernetes API server, useful for debugging API requests |
> | **Audit logs** | Records of individual users, administrators, or system components that have affected the cluster |
> | **Authenticator logs** | Logs from the AWS IAM authenticator, useful for debugging authentication issues |
> | **Controller manager logs** | Logs from the controller manager, which manages core control loops |
> | **Scheduler logs** | Logs from the scheduler, useful for debugging pod scheduling decisions |
>
> ### CloudWatch Observability agent
>
> You can also install the CloudWatch Observability agent as an EKS add-on for enhanced cluster monitoring.
>
> | Setting | Description |
> | - | - |
> | **AWS CloudWatch Observability agent installed on cluster** | Installs the CloudWatch Observability add-on for metrics and logs collection |

> [tab] GCP
>
> ### Cloud Logging
>
> Send cluster logs to Google Cloud Logging. Cloud Logging charges apply.
>
> When Cloud Logging is on, choose which log types to send:
>
> | Log type | Description |
> | - | - |
> | **System logs (required by GKE)** | Logs from system components. GKE requires these, so they cannot be turned off. |
> | **Workload logs** | Logs from your workloads |
> | **API server logs** | Logs from the Kubernetes API server |
> | **Scheduler logs** | Logs from the scheduler |
> | **Controller manager logs** | Logs from the controller manager |
>
> ### Control Plane Metrics
>
> | Setting | Description |
> | - | - |
> | **Control Plane Metrics** | Collects metrics from the Kubernetes control plane components |

> [tab] Azure
>
> ### Control Plane Logging
>
> Send AKS audit and control plane logs to Azure. Porter sends the audit log to a searchable Log Analytics workspace and the other control plane logs to a write-once storage archive.
>
> | Setting | Description |
> | - | - |
> | **Enable control plane logging** | Sends the cluster's audit and control plane logs to Azure. Turning this off keeps the logs that were already collected. |
> | **Use my own destination** | Send the logs to a Log Analytics workspace and storage account you choose, instead of the default destinations. |
> | **Log Analytics workspace** | Resource ID of the workspace that receives the audit log, for example `/subscriptions/.../workspaces/<name>`. If it is in another subscription, grant Porter the `sharedKeys` action (for example, with the Monitoring Contributor role). |
> | **Storage account** | Resource ID of the storage account that archives the other control plane logs, for example `/subscriptions/.../storageAccounts/<name>`. It must be in the cluster's region. If it is in another subscription, grant Porter the `listKeys` action (for example, with the Storage Account Key Operator Service Role). |

## Threat detection and image scanning

> [!NOTE]
>
> This section is available for AWS clusters only.

### AWS GuardDuty

AWS GuardDuty provides intelligent threat detection for your EKS cluster, monitoring for malicious activity and unauthorized behavior.

When you enable the GuardDuty agent, Porter:

1. Installs the agent as an EKS add-on.
2. Turns on GuardDuty and Runtime Monitoring in the cluster's region, if either is off.
3. Creates a `guardduty-data` VPC endpoint, which the agent sends its findings through, if the cluster's VPC has none.

Turning the agent off removes it and any endpoint Porter created. GuardDuty and Runtime Monitoring stay on.

> [!NOTE]
>
> If a delegated administrator account manages GuardDuty for your organization, turn on Runtime Monitoring from that account.

> [!WARNING]
>
> Leave GuardDuty's automated agent configuration for EKS off. Porter manages the agent's version and reverts agent updates that GuardDuty makes.
>
> The endpoint Porter creates accepts traffic only from the cluster, but its DNS name applies to the whole VPC.

| Setting | Description |
| - | - |
| **AWS GuardDuty agent installed on cluster** | Installs the GuardDuty agent on your cluster nodes |

### ECR scanning

Amazon ECR image scanning automatically scans container images for software vulnerabilities.

| Setting | Description |
| - | - |
| **ECR scanning enabled** | When enabled, images pushed to ECR are automatically scanned for vulnerabilities |

## Integrating external monitoring

For application-level monitoring and alerting, integrate with external observability platforms:

> [card] [Datadog](https://docs.porter.run/addons/third-party-observability.md)
>
> Full-stack monitoring with APM, logs, and infrastructure metrics

> [card] [New Relic](https://docs.porter.run/addons/third-party-observability.md)
>
> Application performance monitoring and alerting

> [card] [Grafana](https://docs.porter.run/addons/third-party-observability.md)
>
> Dashboards and visualization for metrics and logs

See [Third party observability](https://docs.porter.run/addons/third-party-observability.md) or reach out to support for more information.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.