Datasource creation request to given Management Agent.


oci management-agent agent create-prometheus-datasource [OPTIONS]

Required Parameters

--compartment-id, -c [text]

Compartment owning this DataSource.

--management-agent-id [text]

Unique Management Agent identifier

--name [text]

Unique name of the DataSource.

--namespace [text]

The OCI monitoring namespace to which scraped metrics should be uploaded.

--url [text]

The url through which the Prometheus Exporter publishes its metrics. (http only)

Optional Parameters

--allow-metrics [text]

Comma separated metric name list. The complete set of desired scraped metrics. Use this property to limit the set of metrics uploaded if required.

--connection-timeout [integer]

Number in milliseconds. The timeout for connecting to the Prometheus Exporter’s endpoint.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link:

--if-match [text]

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.

--max-wait-seconds [integer]

The maximum time to wait for the work request to reach the state defined by --wait-for-state. Defaults to 1200 seconds.

--metric-dimensions [complex type]

The names of other user-supplied properties expressed as fixed values to be used as dimensions for every uploaded datapoint.

This option is a JSON list with items of type MetricDimension. For documentation on MetricDimension please see our API reference: This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--proxy-url [text]

The url of the network proxy that provides access to the Prometheus Exporter’s endpoint (url required property).

--read-data-limit [text]

Number in kilobytes. The limit on the data being sent, not to exceed the agent’s fixed limit of 400 (KB).

--read-timeout [integer]

Number in milliseconds. The timeout for reading the response from the Prometheus Exporter’s endpoint.

--resource-group [text]

OCI monitoring resource group to assign the metric to.

--schedule-mins [integer]

Number in minutes. The scraping occurs at the specified interval.

--wait-for-state [text]

This operation asynchronously creates, modifies or deletes a resource and uses a work request to track the progress of the operation. Specify this option to perform the action and then wait until the work request reaches a certain state. Multiple states can be specified, returning on the first state. For example, --wait-for-state SUCCEEDED --wait-for-state FAILED would return on whichever lifecycle state is reached first. If timeout is reached, a return code of 2 is returned. For any other error, a return code of 1 is returned.

Accepted values are:

--wait-interval-seconds [integer]

Check every --wait-interval-seconds to see whether the work request has reached the state defined by --wait-for-state. Defaults to 30 seconds.

Example using required parameter

Copy the following CLI commands into a file named Run the command by typing “bash” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export compartment_id=<substitute-value-of-compartment_id> #
    export management_agent_id=<substitute-value-of-management_agent_id> #
    export name=<substitute-value-of-name> #
    export namespace=<substitute-value-of-namespace> #
    export url=<substitute-value-of-url> #

    oci management-agent agent create-prometheus-datasource --compartment-id $compartment_id --management-agent-id $management_agent_id --name $name --namespace $namespace --url $url