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-17017575-insights-hyperforce-duke #314

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

Conversation

dukesphere
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

@dukesphere dukesphere requested a review from a team as a code owner November 1, 2024 21:24
@dukesphere dukesphere mentioned this pull request Nov 1, 2024
6 tasks
@dukesphere dukesphere self-assigned this Nov 1, 2024
+
This code comes from Runtime Manager.

URL::
Copy link
Contributor Author

@dukesphere dukesphere Nov 12, 2024

Choose a reason for hiding this comment

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

Currently "Uri" in the UI (Mule app detail header)
Can we change to "URL"? @sathishpaulleo

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
URL::
URL::

[[performance-trends-overview]]
==== Performance Trends

Entities with Slow Response Times::
Copy link
Contributor Author

Choose a reason for hiding this comment

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

UI currently says Entities with slow Response Times
slow -> Slow
@sathishpaulleo

//
//H3: ENTITIES LIST
[[entities-list]]
=== Entities List
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Suggest removing "List"
UX is generally to avoid unnecessary terms like this (self-identification that is obvious)

@sathishpaulleo

Comment on lines +244 to +246
//TODO_TODO: to avoid duplication (see chart with same name this one) CHANGE NAME to something like Policy Violation Volume (or similar)
Policy Violations::
Number of API policy violations
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
//TODO_TODO: to avoid duplication (see chart with same name this one) CHANGE NAME to something like Policy Violation Volume (or similar)
Policy Violations::
Number of API policy violations
//TODO_TODO: to avoid duplication (see chart with same name this one) CHANGE NAME to something like Policy Violation Volume (or similar)
Policy Violations::
Number of API policy violations

@sathishpaulleo

Comment on lines +16 to +19
//TODO: suggest Runtime Version conform on Runtime (App) vs. Runtime Version (API)

Runtime::
Mule runtime engine version of this Mule app
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
//TODO: suggest Runtime Version conform on Runtime (App) vs. Runtime Version (API)
Runtime::
Mule runtime engine version of this Mule app
//TODO: suggest Runtime Version conform on Runtime (App) vs. Runtime Version (API)
Runtime::
Mule runtime engine version of this Mule app

@sathishpaulleo

Comment on lines +22 to +23
Replicas::
Virtual core fraction and count of this Mule app, for example, *0.1 vCores x 1* (= 10% of 1 vCore)
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
Replicas::
Virtual core fraction and count of this Mule app, for example, *0.1 vCores x 1* (= 10% of 1 vCore)
Replicas::
Virtual core fraction and count of this Mule app, for example, *0.1 vCores x 1* (= 10% of 1 vCore)

pls verify description of Replicas, @sathishpaulleo

Comment on lines +218 to +220
//TODO_TODO_TODO: What if empty but seems to be running?
API Instance ID::
Instance identifier for an API implementation incorporated into a Flex Gateway or API Gateway runtime
Copy link
Contributor Author

@dukesphere dukesphere Nov 12, 2024

Choose a reason for hiding this comment

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

Suggested change
//TODO_TODO_TODO: What if empty but seems to be running?
API Instance ID::
Instance identifier for an API implementation incorporated into a Flex Gateway or API Gateway runtime
//TODO_TODO_TODO: What if value empty but seems to be Active?
API Instance ID::
Instance identifier for an API implementation incorporated into a Flex Gateway or API Gateway runtime

@sathishpaulleo

Comment on lines +222 to +224
//TODO: capitalize "version"?
API version::
Version of the API implementation
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
//TODO: capitalize "version"?
API version::
Version of the API implementation
//TODO: capitalize "version"?
API version::
Version of the API implementation

for consistency @sathishpaulleo

Comment on lines +282 to +284
// TODO: capitalize "paths" -> "Paths" and "N" to "20" if that's the limit (SATHISH)
Request Volume by Top N paths::
Number of requests over time from endpoints with the most requests
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
// TODO: capitalize "paths" -> "Paths" and "N" to "20" if that's the limit (SATHISH)
Request Volume by Top N paths::
Number of requests over time from endpoints with the most requests
// TODO: capitalize "paths" -> "Paths" and "N" to "20" if that's the limit (SATHISH)
Request Volume by Top N paths::
Number of requests over time from endpoints with the most requests

@sathishpaulleo

Comment on lines +294 to +298
// TODO: downloads available?
Failed Requests Volume by HTTP Method::
Number of unsuccessful requests over time, grouped by the HTTP method used
//+
//include::partial$include-insights-charts.adoc[tag="download-as"]
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
// TODO: downloads available?
Failed Requests Volume by HTTP Method::
Number of unsuccessful requests over time, grouped by the HTTP method used
//+
//include::partial$include-insights-charts.adoc[tag="download-as"]
// TODO: downloads available?
Failed Requests Volume by HTTP Method::
Number of unsuccessful requests over time, grouped by the HTTP method used
//+
//include::partial$include-insights-charts.adoc[tag="download-as"]

@sathishpaulleo

Comment on lines +300 to +304
// TODO: downloads available?
Failed Requests Volume by Response Code::
Number of unsuccessful requests over time, grouped by the response code (such as *2xx*)
//+
//include::partial$include-insights-charts.adoc[tag="download-as"]
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
// TODO: downloads available?
Failed Requests Volume by Response Code::
Number of unsuccessful requests over time, grouped by the response code (such as *2xx*)
//+
//include::partial$include-insights-charts.adoc[tag="download-as"]
// TODO: downloads available?
Failed Requests Volume by Response Code::
Number of unsuccessful requests over time, grouped by the response code (such as *2xx*)
//+
//include::partial$include-insights-charts.adoc[tag="download-as"]

@sathishpaulleo

Comment on lines +306 to +311
// TODO: capitalize "paths" -> "Paths" and "N" to "20" if that's the limit (SATHISH)
// TODO: downloads available?
Failed Requests by Top N paths::
Number of unsuccessful requests over time from endpoints with the most requests
//+
//include::partial$include-insights-charts.adoc[tag="download-as"]
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
// TODO: capitalize "paths" -> "Paths" and "N" to "20" if that's the limit (SATHISH)
// TODO: downloads available?
Failed Requests by Top N paths::
Number of unsuccessful requests over time from endpoints with the most requests
//+
//include::partial$include-insights-charts.adoc[tag="download-as"]
// TODO: capitalize "paths" -> "Paths" and "N" to "20" if that's the limit (SATHISH)
// TODO: downloads available?
Failed Requests by Top N paths::
Number of unsuccessful requests over time from endpoints with the most requests
//+
//include::partial$include-insights-charts.adoc[tag="download-as"]

@sathishpaulleo

Comment on lines +321 to +324
//TODO: RESPONSE TIME UNIT MISSING from chart
//can download as CSV, XLS
Top 20 Paths by Average Response Time::
Average response time of the 20 most requested endpoints.
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
//TODO: RESPONSE TIME UNIT MISSING from chart
//can download as CSV, XLS
Top 20 Paths by Average Response Time::
Average response time of the 20 most requested endpoints.
//TODO: RESPONSE TIME UNIT MISSING from chart
//can download as CSV, XLS
Top 20 Paths by Average Response Time::
Average response time of the 20 most requested endpoints.

@sathishpaulleo

Comment on lines +328 to +332
//TODO: 95p or capitalize "percentile" -> "Percentile"
//TODO: Can we say "Bottom 95p Response Time" or similar?
//You can download as CSV, XLS
Top 20 Paths by 95th percentile Response Time::
For the 20 most requested endpoints, the average response time of 95% of requests; the response time of the remaining 5% is typically greater than this number
Copy link
Contributor Author

@dukesphere dukesphere Nov 12, 2024

Choose a reason for hiding this comment

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

Suggested change
//TODO: 95p or capitalize "percentile" -> "Percentile"
//TODO: Can we say "Bottom 95p Response Time" or similar?
//You can download as CSV, XLS
Top 20 Paths by 95th percentile Response Time::
For the 20 most requested endpoints, the average response time of 95% of requests; the response time of the remaining 5% is typically greater than this number
//TODO: 95p or capitalize "percentile" -> "Percentile"
//TODO: Response time units missing
Top 20 Paths by 95th percentile Response Time::
For the 20 most requested endpoints, the average response time of 95% of requests; the response time of the remaining 5% is typically greater than this number

@sathishpaulleo

Comment on lines +370 to +372
//TODO: "Requests" -> "Request", and can we remove "Volume"? or change to "Request Total"
Total Requests Volume::
Total number of requests
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
//TODO: "Requests" -> "Request", and can we remove "Volume"? or change to "Request Total"
Total Requests Volume::
Total number of requests
//TODO: "Requests" -> "Request", and can we remove "Volume"? or change to "Request Total"
Total Requests Volume::
Total number of requests

@sathishpaulleo

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.

1 participant