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

W-15161420 tracing and entities #272

Open
wants to merge 46 commits into
base: latest
Choose a base branch
from

Conversation

sarathecoubian
Copy link
Contributor

Writer's Quality Checklist

Before merging your PR, did you:

  • Run spell checker
  • Run link checker to check for broken xrefs
  • Check for orphan files
  • Perform a local build and do a final visual check of your content, including checking for:
    • Broken images
    • Dead links
    • Correct rendering of partials if they are used in your content
    • Formatting issues, such as:
      • Misnumbered ordered lists (steps) or incorrectly nested unordered lists
      • Messed up tables
      • Proper indentation
      • Correct header levels
  • Receive final review and signoff from:
    • Technical SME
    • Product Manager
    • Editor or peer reviewer
    • Reporter, if this content is in response to a reported issue (internal or external feedback)
  • If applicable, verify that the software actually got released

sarathecoubian and others added 9 commits February 9, 2024 15:04
* W-13840863-entities-overview-limited-GA

* W-13840863-entities-overview-limited-GA

* W-13840863-entities-overview-limited-GA

* W-13840863-entities-overview-limited-GA

* W-13840863-entities-overview-limited-GA

* Update entities-overview.adoc

* Update modules/ROOT/pages/entities-overview.adoc

* Apply suggestions from code review

* Updates from tech review

* Updates from tech review

* Update entities-overview.adoc

* Update modules/ROOT/pages/entities-overview.adoc

---------

Co-authored-by: Emilee Burke <[email protected]>
Co-authored-by: emileeburkeVT <[email protected]>
* W-14038258-distributed-tracing-overview

* W-14038258-distributed-tracing-overview

* Updating file name to match UI

* Updates from tech review

* Apply suggestions from code review

* Apply suggestions from code review

* Update trace-details.adoc

* Update nav.adoc

* Apply suggestions from code review

Co-authored-by: emileemooreVT <[email protected]>

* Update modules/ROOT/pages/traces-overview.adoc

---------

Co-authored-by: emileeburkeVT <[email protected]>
Co-authored-by: Emilee Burke <[email protected]>
Co-authored-by: emileemooreVT <[email protected]>
@sarathecoubian sarathecoubian requested a review from a team as a code owner March 1, 2024 20:48
modules/ROOT/nav.adoc Outdated Show resolved Hide resolved
Copy link
Contributor

@dhirsch1 dhirsch1 left a comment

Choose a reason for hiding this comment

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

Some general comments:

  • I see that some of the H1s don't match what is in the TOC. They should match unless you need to shorten the wording in the TOC.
  • There is one indented topic under Explore Trace Data for Apps and APIs in the TOC. It is better not to have only one topic at this level if you can help it.
  • It seems like you are documenting the interface in places where you don't need to do this. Can you see if you can make some of this information more task oriented and/or delete some of the interface documentation, such as when you list values?
  • Consider using tables for lists of field descriptions. This is not a necessity, but they are easy to skim. If you want to keep descriptions in lists, separate the description from the field name with a + so that the description is on a different line. I marked this once but not everywhere it applies.
  • Global: using > by using
  • Remove lead articles from descriptions.

I didn't edit the commented text.

modules/ROOT/pages/anypoint-insights.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/anypoint-insights.adoc Outdated Show resolved Hide resolved

The Anypoint Monitoring Archive API enables you to download files that contain https://anypoint.mulesoft.com/exchange/portals/anypoint-platform/f1e97bc6-315a-4490-82a7-23abe036327a.anypoint-platform/anypoint-monitoring-archive-api/minor/1.0/pages/Metric%20Data/[JSON objects] that represent one or more metric events. You can also write an application to navigate the data collected by the API and integrate it into your own system.

You can also enable non-aggregated API events by setting this property: `anypoint.platform.config.analytics.agent.api_raw_metrics.enabled=true`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Two "You can also..." in a row. Can you change the wording of one of them?

modules/ROOT/pages/am-apis.adoc Outdated Show resolved Hide resolved

Anypoint Monitoring has a variety of APIs that enable you to view, sort, and query your data:

* Anypoint Monitoring Archive API: enables you to navigate and discover your API metrics data using a directory hierarchy.
Copy link
Contributor

Choose a reason for hiding this comment

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

I suggest using this format to make it easier to skim:

  • Anypoint Monitoring Archive API

Enables...

modules/ROOT/pages/anypoint-insights.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/anypoint-insights.adoc Outdated Show resolved Hide resolved
Comment on lines 43 to 51
* `entry_api_version`: The version number of the API for which you want to see traces.
* `entry_entity_id`: The ID of the entity for which you want to see traces.
* `entry_entity_name`: The name of the entity for which you want to see traces.
* `entry_entity_type`: The type of entity for which you want to see traces. You can query apps or APIs.
* `entry_span_id`: The ID of a span contained in traces.
* `entry_span_name`: The name of a span contained in traces.
* `environment_name`: The name of the environment that contains entities for which you want to see traces.
* `http_status_code`: The HTTP status code associated with a trace. You can query 0, 200, or 500 codes.
* `trace_id`: The ID associated with a trace.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggested change
* `entry_api_version`: The version number of the API for which you want to see traces.
* `entry_entity_id`: The ID of the entity for which you want to see traces.
* `entry_entity_name`: The name of the entity for which you want to see traces.
* `entry_entity_type`: The type of entity for which you want to see traces. You can query apps or APIs.
* `entry_span_id`: The ID of a span contained in traces.
* `entry_span_name`: The name of a span contained in traces.
* `environment_name`: The name of the environment that contains entities for which you want to see traces.
* `http_status_code`: The HTTP status code associated with a trace. You can query 0, 200, or 500 codes.
* `trace_id`: The ID associated with a trace.
* `entry_api_version`: TVersion number of the API for which you want to see traces.
* `entry_entity_id`: ID of the entity for which you want to see traces.
* `entry_entity_name`: Name of the entity for which you want to see traces.
* `entry_entity_type`: Type of entity for which you want to see traces. You can query apps or APIs.
* `entry_span_id`: ID of a span contained in traces.
* `entry_span_name`: Name of a span contained in traces.
* `environment_name`: Name of the environment that contains entities for which you want to see traces.
* `http_status_code`: HTTP status code associated with a trace. You can query 0, 200, or 500 codes.
* `trace_id`: ID associated with a trace.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants