Merge branch 'v2.x' into W-17032550-api-alert-limits-fa

Author: failup

modules/ROOT/pages/_partials/analytics-eol.adoc

@@ -1 +1 @@
-:page-notice-banner-message: Mule API Analytics is scheduled for End of Life on November 30, 2024. Use <a href="https://docs.mulesoft.com/monitoring/">Anypoint Monitoring</a> instead. Contact your MuleSoft account representative for more information.
+:page-notice-banner-message: Mule API Analytics will soon be replaced by  <a href="https://docs.mulesoft.com/monitoring/">Anypoint Monitoring</a>. Start transitioning to Anypoint Monitoring to monitor APIs effectively. Contact your MuleSoft representative for more information. 

modules/ROOT/pages/_partials/key-metrics.adoc

@@ -0,0 +1,29 @@
+[[key-metrics]]
+== Understanding Key Metrics
+
+The *Key Metrics* section of the API summary contains the following charts:
+
+Total Requests::
+Sum of requests in the selected time period for the given API.
++
+Data is aggregated in one minute increments.
+
+Total Policy Violations::
+Sum of requests that return policy violations.
++
+Data is aggregated in one minute increments.
+
+Total Errors::
+Sum of HTTP response codes that occur in the selected time period. The response codes counted in this metric are 400, 401, 402, 403, 404, 405, 408, 409, 410, 411, 412, 413, 415, 416, 417, 420, 422, 429, 500, 502, 503, 504, 504, 510, and 511.
++
+Data is aggregated in one minute increments. In the chart, HTTP response codes are abbreviated as 4xx and 5xx.
+
+Average Response Time::
+Average response time of requests in the selected time period for the given API.
++
+Data is aggregated in one minute increments.
+
+
+== Setting the Time Period for Key Metrics
+
+You can view the data points collected for the last given period of time (such as the last 5 or 30 minutes) or over a given date and time range. Use the drop-down in the calendar icon to select the time period to display.

modules/ROOT/pages/analytics-landing-page.adoc

@@ -18,6 +18,10 @@ You can view data from a policy perspective in the Mule API Analytics dashboard,
 
 The *Mule API Analytics* tab is visible only to users who have `Read API` permission. Charts are visible for users who have `View Analytics` permission.
 
+[NOTE]
+API Analytics isn't available on Hyperforce deployments.
+
+
 == See Also
 
 *** xref:viewing-api-analytics.adoc[Reviewing Analytics usage]

modules/ROOT/pages/create-instance-task-flex.adoc

@@ -52,6 +52,17 @@ In the following diagram, different routes manage requests to flight information
 
 image:multiple-upstreams.png[Flex Gateway manages the traffic to multiple upstreams]
 
+=== Limits
+
+[%header%autowidth.spread,cols="a,>.<a,a"]
+|===
+| Limit | Value | Notes
+| Upstreams per API | 50 | Each API supports 50 upstreams. The 50 upstreams can consist of a combination of different routes.
+| Routes per API | 50 | Each API supports 50 routes. 
+| Upstreams per route| 10|
+| Headers per route rule | 10| 
+| ===
+
 === Routes
 
 Each API instance supports up to 50 routes and each route can support up to 10 upstream services. Configure what requests a route can receive by defining route rules and a route order. At least one route per API instance is required. 
@@ -60,10 +71,6 @@ Before adding additional routes, enter an optional *Route label* for clarity.
 
 You can add additional routes by clicking *Add Route*, and you can delete routes by clicking the *Trash Can* icon (image:trash-can-icon.png[2%,2%]). If only one route is defined, you cannot delete that route.
 
-=== Limits
-
-include::partial$api-manager-limits.adoc[]
-
 ==== Route Rules
 
 You can direct requests to different routes by using route rules. 
@@ -163,6 +170,7 @@ Configure the following fields for each upstream service:
 
 
 
+
 //promote-api
 include::partial$task-promote-api.adoc[]
 

modules/ROOT/pages/create-instance-task-mule.adoc

@@ -59,6 +59,55 @@ include::partial$api-configuration-tables.adoc[tags=mule-proxy-upstream]
 +
 include::partial$task-add-api-instance.adoc[tags=last-steps]
 
+== Create New API Asset
+
+NOTE: This feature is only available on GovCloud environments. If you want to create an API asset in other environments, refer to xref:exchange::to-create-an-asset.adoc#create-an-api-asset[]
+
+An API asset specifies an interface completely, including its functions, descriptions, how to handle return codes, and dependencies.
+
+Creating an asset sets the asset type, which cannot be changed. All versions of an asset always have the same type.
+
+To create an API asset:
+
+. In API Manager, click *Add API*.
+
+. From the dropdown list, select *Create new API asset*
+
+. Enter a name for the asset.
+
+. Select the asset type from the drop-down list:
+
+** REST API - RAML: Provide a RAML API specification file. RAML specifications must be a RAML file (.raml).
+
+** REST API - OAS: Provide an OAS API specification file. OAS specifications can be either a YAML (.yaml) or JSON (.json) file. Exchange supports OAS 2.0 and OAS 3.0 specifications.
+
+** SOAP API - WSDL: Provide a WSDL API specification file. SOAP specifications file can be either a WSDL (.wsdl) or XML (.xml) file.
+
+** AsyncAPI: Provide an AsyncAPI specification file in a YAML (.yaml) or JSON (.json) file.
+
+** AsyncAPI with Avro schemas: Provide an Avro fragment in an AVSC (.avsc) file.
+
+** API Spec Fragment - RAML: Provide an API Fragment RAML specification file. Fragment specifications must be a RAML file (.raml).
+
+** API Spec Fragment - JSON: Provide an API Fragment JSON specification (.json) file.
+
+** API Spec Fragment - OpenAPI Specification (OAS): Provide an API Fragment OpenAPI specification file either JSON or YAML.
+
+** HTTP API: This asset does not require a file. This asset type provides an API endpoint that is defined by API Manager.
+
+. For assets that require a file:
+
+.. Click *Choose File* to locate the API specification file.
+
+.. Select the main file of the API. +
+  If the file is a ZIP, the selected main file must be in the root directory of the ZIP file. If the file is not a ZIP or if the file is a ZIP file with only one main file, then the main file is selected automatically.
+
+. If you want to edit the *GroupId*, *AssetId*, *Version*, and *API version* (GAV), click *Advanced*. +
+Exchange generates the group ID, asset ID, and version (GAV) for you, and you can change these values as needed. You can change an API’s asset version and version separately. Use the advanced settings to change the asset version.
+
+. Choose an option for *Lifecycle state*. The default is Stable.
+
+. Click *Publish*.
 
 //promote-api
 include::partial$task-promote-api.adoc[]

modules/ROOT/pages/latest-overview-concept.adoc

@@ -109,13 +109,21 @@ see xref:api-contracts-landing-page.adoc[].
 
 === API Instances
 
-An API instance describes a configuration of an API that is deployed on one of the following runtimes: Flex Gateway, Mule Gateway, or Anypoint Service Mesh. API instances are managed by API Manager after they are created by using the add, promote, or import options. API instances remain under management until they are deleted.
+An API instance describes a configuration of an API that is deployed on one of the following runtimes: Flex Gateway, Mule Gateway, or Anypoint Service Mesh. API instances are managed by API Manager after they are created by using the add, promote, or import options. API instances remain under management until they are deleted. To view the API Summary for an API instance, click the API instance name.
+
+For more detail, see xref:api-instance-landing-page.adoc[].
+
+=== API Summary
 
 The API Summary shows key information about a deployed API instance:
 
 image::api-instance-summary.png[API Summary page]
 
-For details, see xref:api-instance-landing-page.adoc[].
+=== Key Metrics
+
+The API Summary page includes a Key Metrics section. 
+
+include::partial$key-metrics.adoc[leveloffset=+2]
 
 === API Alerts
 
@@ -230,6 +238,18 @@ The support for environments in strategic components of Anypoint Platform elimin
 
 For details, see xref:access-management::environments.adoc[].
 
+[[APIM-hyperforce]]
+== API Manager on Hyperforce
+
+All features of Anypoint API Manager are supported on Hyperforce with these exceptions:
+
+* API Alerts. Instead, use xref:monitoring::index.adoc[Anypoint Monitoring], for detailed logs to monitor API performance.
+* Key Metrics. Instead, use xref:monitoring::index.adoc[Anypoint Monitoring], to access metrics to monitor API performance.
+* Mule Hybrid and CloudHub deployment. Migrate to xref:cloudhub-2::index.adoc[CloudHub 2.0] to deploy your APIs.
+* API Service Mesh is scheduled for End of Life and is not available on Hyperforce. For service mesh capabilities, consider upgrading to xref:gateway::index.adoc[API Gateway].
+* API Manager 1.x. Migrate to API Manager 2.x dor continued use and access to the latest features.
+
+
 == See Also
 
 * xref:general::api-led-overview.adoc[]

modules/ROOT/pages/using-api-alerts.adoc

@@ -4,7 +4,22 @@ include::_attributes.adoc[]
 endif::[]
 :keywords: alerts, api, api alerts
 
-Anypoint Platform alerts you about request behavior, performance issues, actions related to client application contracts, and runtime events. The platform supports three types of alerts: API alerts, contracts alerts, and runtime alerts. API alerts and contracts alerts are managed by Anypoint API Manager (API Manager). Runtime alerts are managed by Anypoint Runtime Manager (Runtime Manager).
+Anypoint Platform alerts you about request behavior, performance issues, actions related to client application contracts, and runtime events. 
+
+The platform supports three types of alerts: 
+
+* API alerts
+* Contracts alerts
+* Runtime alerts
+
+API alerts and contracts alerts are managed by Anypoint API Monitoring. 
+Runtime alerts are managed by Anypoint Runtime Manager (Runtime Manager).
+Refer to xref:gateway::flex-use-api-alerts.adoc[Using Flex Gateway API Alert] to learn how to use the new API Monitoring alerts.
+
+NOTE: Customers who were already using legacy Analytics-based API Alerts on API Manager instead of API Monitoring can continue to access this functionality until November 30, 2024. This functionality is not available for new clients.
+
+[NOTE]
+API Alerts aren't available on Hyperforce deployments.
 
 == API Alerts
 
@@ -51,6 +66,9 @@ After an alert is triggered, API Manager sends the first set of two notification
 
 Note: API Alerts are sent from `[email protected]`. This cannot be customized.
 
+The alert email can be sent before the corresponding sliding window has fully closed. +
+Although the alert condition is evaluated based on the sliding window, the condition may be met before all metrics for the window arrive. For example: If the alert condition is set to "error count > 1 in a 5-minute window" and 10 errors occur within the first minute, the alert email is sent during that first minute, even though the sliding window continues to accumulate metrics for the remaining 4 minutes.
+
 == Contracts Alerts
 
 API Manager automatically notifies users when actions related to contracts occur. For instance, when a client application requests access to an API instance, API Manager sends a notification with the status of the request. Depending on the configuration, status might indicate that the request is pending manual approval, or it might indicate that the request has been auto-approved.