Configure Overload Protection Collectors

Use the REST API endpoint below to configure the overload protection collectors. A GET request to the CreateForm URL retrieves both the default parameters and the create URL. Send a POST request to the create URL to create the child MBean.

URL Syntax

For the GET:

/management/weblogic/latest/edit/customResources/sipserver/customResource/overloadProtection/collectors/collectorCreateForm

For the POST or DELETE:

/management/weblogic/latest/edit/customResources/sipserver/customResource/overloadProtection/collectors/collectors

HTTP Methods

GET
POST
DELETE

Parameters

Table 17-7 URL Parameters

Names	Description
links	Set to `none` if you want to remove the links from the response. Set to an enumerated list of the links to return. For example: `.../collectors/collectorCreateForm?links=create`
fields	Set to an enumerated list of the fields to return. For example: `.../collectors/collectorCreateForm?links=none&fields=enabled`

Examples

Example 17-22 Get the Overload Protection Collectors CreateForm

The example below returns the required parameters to create the overload protection collector without any of the links.

curl -u 'weblogic:<password>' \
    "http://10.0.0.1:7001/management/weblogic/latest/edit/customResources/sipserver/customResource/overloadProtection/collectors/collectorCreateForm?links=none"

Example response:

{
    "attributes": null,
    "collectorName": null,
    "collectorType": null,
    "name": null
}

Example 17-23 Create an Overload Protection Collector

curl -X POST \
  -d@config.json \
  -u weblogic:<password> \
  -H "X-Requested-By: MyClient" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  'http://10.0.0.1:7001/management/weblogic/latest/edit/customResources/sipserver/customResource/overloadProtection/collectors/collectors'

The contents of config.json:

{   
  "name": "queue-length", 
  "attributes": "queue-length", 
  "collectorName": "queue-length",
  "collectorType": "com.bea.sip.engine.server.olp.collector.QueuelengthCollector"
}

Example 17-24 Get the Attributes of the Overload Protection Collector

First, make a GET request to the collectors/collectors URL to retrieve links at which you can view collector information.

curl -u 'weblogic:<password>' \
  "http://10.0.0.1:7001/management/weblogic/latest/serverConfig/customResources/sipserver/customResource/overloadProtection/collectors/collectors"

Next, make a GET request to the links returned under the items parameter:

curl -u 'weblogic:<password>' \
    "http://10.0.0.1:7001/management/weblogic/latest/serverConfig/customResources/sipserver/customResource/overloadProtection/collectors/collectors/queue-length"

An examples response:

{
    "links": [
        {
            "rel": "parent",
            "href": "http://10.0.0.1:7001/management/weblogic/latest/serverConfig/customResources/sipserver/customResource/overloadProtection/collectors/collectors"
        },
        {
            "rel": "self",
            "href": "http://10.0.0.1:7001/management/weblogic/latest/serverConfig/customResources/sipserver/customResource/overloadProtection/collectors/collectors/queue-length"
        },
        {
            "rel": "canonical",
            "href": "http://10.0.0.1:7001/management/weblogic/latest/serverConfig/customResources/sipserver/customResource/overloadProtection/collectors/collectors/queue-length"
        }
    ],
    "identity": [
        "customResources",
        "sipserver",
        "customResource",
        "overloadProtection",
        "collectors",
        "collectors",
        "queue-length"
    ],
    "name": "queue-length",
    "attributes": "queue-length",
    "collectorName": "queue-length",
    "collectorType": "com.bea.sip.engine.server.olp.collector.QueuelengthCollector"
}