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

adding rum-cli-examples #8984

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Conversation

onkabes
Copy link

@onkabes onkabes commented Oct 17, 2024

Issue #, if available:

Description of changes:

Adding example CLI commands for Amazon CloudWatch RUM: https://docs.aws.amazon.com/cli/latest/reference/rum/

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@elysahall elysahall self-requested a review October 21, 2024 16:23
@elysahall elysahall self-assigned this Oct 21, 2024
@elysahall elysahall added the documentation This is a problem with documentation. label Oct 21, 2024
@elysahall elysahall added the pr:work-in-progress This PR is a draft and needs further work. label Nov 11, 2024
Copy link
Collaborator

@elysahall elysahall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@onkabes
I've finished reviewing. Please fix these formatting issues and push your updated commit. Thanks!

Output::

{
"Errors": [],
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"Errors": [],
"Errors": [],


{
"Errors": [],
"MetricDefinitions": [
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"MetricDefinitions": [
"MetricDefinitions": [

"Name": "AmazonVisitCount",
"Namespace": "PageVisit"
}
]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
]
]

"Namespace": "PageVisit"
}
]
}
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
}
}

@@ -0,0 +1,27 @@
**To specify the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination**

The following ``batch-create-rum-metric-definitions`` specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination. ::
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The following ``batch-create-rum-metric-definitions`` specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination. ::
The following ``batch-create-rum-metric-definitions`` example has a CloudWatch RUM app monitor send extended and custom metrics to the specified destination. ::

@@ -0,0 +1,10 @@
**To update the configuration of an existing app monitor**

The following ``update-app-monitor`` updates the configuration of an existing app monitor. If the command succeeds, no output is returned. ::
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The following ``update-app-monitor`` updates the configuration of an existing app monitor. If the command succeeds, no output is returned. ::
The following ``update-app-monitor`` example updates the configuration of an existing app monitor. ::

--app-monitor-configuration 'AllowCookies=true,EnableXRay=true' \
--custom-events Status=ENABLED \
--name AWSApp

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This command produces no output.

@@ -0,0 +1,11 @@
**To modifies one existing metric definition for CloudWatch RUM extended metric**
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**To modifies one existing metric definition for CloudWatch RUM extended metric**
**To modify an existing metric definition for CloudWatch RUM extended metric**

@@ -0,0 +1,11 @@
**To modifies one existing metric definition for CloudWatch RUM extended metric**

The following ``update-rum-metric-definition`` modifies one existing metric definition for CloudWatch RUM extended metrics. If the command succeeds, no output is returned. ::
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The following ``update-rum-metric-definition`` modifies one existing metric definition for CloudWatch RUM extended metrics. If the command succeeds, no output is returned. ::
The following ``update-rum-metric-definition`` example modifies one existing metric definition for CloudWatch RUM extended metrics. ::

--destination CloudWatch \
--metric-definition 'Namespace=PageVisit,Name=AmazonVisitCount,DimensionKeys={event_details.current_url=URL},EventPattern="{\"metadata\":{\"browserName\":[\"Chrome\"]},\"event_type\":[\"my_custom_event\"],\"event_details\":{\"current_url\":[\"amazonaws.com\"]}}"' \
--metric-definition-id 8b67gh3-r678-q987-a576-b9fj7kf234kd

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This command produces no output.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation. pr:work-in-progress This PR is a draft and needs further work.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants