Skip to content

Allow owner to switch on API monitoring #1512

Closed
@bajiat

Description

@bajiat

Currently the API monitoring in APInf is providing false results. See error #1386. We should allow the owners to select whether the API is being monitored or not and to choose the URL. At first phase, we are not providing authentication for monitoring.

See also comments and screenshots from Monitoring EPIC #1183.

User story

As an API owner I want to be able to switch on API monitoring

As an API owner I want to be able to select the URL that is being monitored

Definition of done

  • API owner can enable the API monitoring either from API settings or from Monitoring tab..
  • API owner can select / give the URL to be monitored.
    • Optionally, give a default for URL and allow them to change/edit.
  • Monitoring happens with http request instead of pinging.
  • If monitoring is enabled, the monitoring call is made once in hour(?)
  • Only show the monitoring icon in API profile and catalog, if API is being monitored (owner has switched that on)

Wireframe

When Monitoring is not enabled
apimonitoring

On enabling API monitoring, the URL field gets activated. Owner is allowed to use only GET method for API monitoring. Owner should add path to the base URL of the API to get valid results about API status. info icon should describe how the API process works.
apimonitoring2

For APIs with Monitoring Enable, small circles indicating API health should appear in API profile (see wireframe2), card view and table view in API catalog (indicated with squares)
apimonitoringcatalogview

apimonitoringtableview

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions