Skip to content
AWS for Query.Farm

aws.pi.get_performance_analysis_report

Example SQL Queries

SELECT * FROM
aws.pi.get_performance_analysis_report
WHERE
"service_type" = 'VALUE'
AND "identifier" = 'VALUE'
AND "analysis_report_id" = 'VALUE';

Description

Retrieves the report including the report ID, status, time details, and the insights with recommendations. The report status can be RUNNING, SUCCEEDED, or FAILED. The insights include the description and recommendation fields.

Table Definition

Column NameColumn Data Type
analysis_report_id Required Input Column

A unique identifier of the created analysis report. For example, report-12345678901234567 

VARCHAR
identifier Required Input Column

An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.

To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

VARCHAR
service_type Required Input Column

The Amazon Web Services service for which Performance Insights will return metrics. Valid value is RDS.

VARCHAR
accept_language Input Column

The text language in the report. The default language is EN_US (English). 

VARCHAR
text_format Input Column

Indicates the text format in the report. The options are PLAIN_TEXT or MARKDOWN. The default value is plain text.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
analysis_report

The summary of the performance analysis report created for a time period.

STRUCT(
    "analysis_report_id" VARCHAR,
    "identifier" VARCHAR,
    "service_type" VARCHAR,
    "create_time" TIMESTAMP_S,
    "start_time" TIMESTAMP_S,
    "end_time" TIMESTAMP_S,
    "status" VARCHAR,
    "insights" STRUCT(
        "insight_id" VARCHAR,
        "insight_type" VARCHAR,
        "context" VARCHAR,
        "start_time" TIMESTAMP_S,
        "end_time" TIMESTAMP_S,
        "severity" VARCHAR,
        "description" VARCHAR,
        "recommendations" STRUCT(
            "recommendation_id" VARCHAR,
            "recommendation_description" VARCHAR
        )[],
        "insight_data" STRUCT(
            "performance_insights_metric" STRUCT(
                "metric" VARCHAR,
                "display_name" VARCHAR,
                "dimensions" MAP(VARCHAR, VARCHAR),
                "value" DOUBLE
            )
        )[],
        "baseline_data" STRUCT(
            "performance_insights_metric" STRUCT(
                "metric" VARCHAR,
                "display_name" VARCHAR,
                "dimensions" MAP(VARCHAR, VARCHAR),
                "value" DOUBLE
            )
        )[]
    )[]
)
Show child fields
analysis_report.analysis_report_id

The name of the analysis report.

analysis_report.create_time

The time you created the analysis report.

analysis_report.end_time

The analysis end time in the report.

analysis_report.identifier

The unique identifier of the analysis report.

analysis_report.insights[]
Show child fields
analysis_report.insights[].baseline_data[]
Show child fields
analysis_report.insights[].baseline_data[].performance_insights_metric

This field determines the Performance Insights metric to render for the insight. The name field refers to a Performance Insights metric.

Show child fields
analysis_report.insights[].baseline_data[].performance_insights_metric.dimensions

A dimension map that contains the dimensions for this partition.

analysis_report.insights[].baseline_data[].performance_insights_metric.display_name

The Performance Insights metric name.

analysis_report.insights[].baseline_data[].performance_insights_metric.metric

The Performance Insights metric.

analysis_report.insights[].baseline_data[].performance_insights_metric.value

The value of the metric. For example, 9 for db.load.avg.

analysis_report.insights[].context

Indicates if the insight is causal or correlated insight.

analysis_report.insights[].description

Description of the insight. For example: A high severity Insight found between 02:00 to 02:30, where there was an unusually high DB load 600x above baseline. Likely performance impact.

analysis_report.insights[].end_time

The end time of the insight. For example, 2018-10-30T00:00:00Z.

analysis_report.insights[].insight_data[]
Show child fields
analysis_report.insights[].insight_data[].performance_insights_metric

This field determines the Performance Insights metric to render for the insight. The name field refers to a Performance Insights metric.

Show child fields
analysis_report.insights[].insight_data[].performance_insights_metric.dimensions

A dimension map that contains the dimensions for this partition.

analysis_report.insights[].insight_data[].performance_insights_metric.display_name

The Performance Insights metric name.

analysis_report.insights[].insight_data[].performance_insights_metric.metric

The Performance Insights metric.

analysis_report.insights[].insight_data[].performance_insights_metric.value

The value of the metric. For example, 9 for db.load.avg.

analysis_report.insights[].insight_id

The unique identifier for the insight. For example, insight-12345678901234567.

analysis_report.insights[].insight_type

The type of insight. For example, HighDBLoad, HighCPU, or DominatingSQLs.

analysis_report.insights[].recommendations[]
Show child fields
analysis_report.insights[].recommendations[].recommendation_description

The recommendation details to help resolve the performance issue. For example, Investigate the following SQLs that contributed to 100% of the total DBLoad during that time period: sql-id

analysis_report.insights[].recommendations[].recommendation_id

The unique identifier for the recommendation.

analysis_report.insights[].severity

The severity of the insight. The values are: Low, Medium, or High.

analysis_report.insights[].start_time

The start time of the insight. For example, 2018-10-30T00:00:00Z.

analysis_report.service_type

List the tags for the Amazon Web Services service for which Performance Insights returns metrics. Valid values are as follows:

  • RDS

  • DOCDB

analysis_report.start_time

The analysis start time in the report.

analysis_report.status

The status of the created analysis report.