Jump to

• Request
• Response

View This WLDF Instrumentation Monitor

get

/management/weblogic/{version}/domainConfig/serverTemplates/{name}/serverDiagnosticConfig/WLDFBuiltinSystemResourceDescriptorBean/instrumentation/WLDFInstrumentationMonitors/{name}

View this WLDF instrumentation monitor.

Request

Path Parameters

• name: string
  The name property of the instance in the collection.
• version: string
  The version of the WebLogic REST interface.

Query Parameters

• excludeFields(optional): string
  The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
• excludeLinks(optional): string
  The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
• fields(optional): string
  The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
• links(optional): string
  The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.

Security

• Admin: basic
  Type: basic

  Description: A user in the Admin security role.
• Deployer: basic
  Type: basic

  Description: A user in the Deployer security role.
• Monitor: basic
  Type: basic

  Description: A user in the Monitor security role.
• Operator: basic
  Type: basic

  Description: A user in the Operator security role.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns this WLDF instrumentation monitor.

Body ()

Root Schema : WLDF Instrumentation Monitor

Type: object

Show Source

• actions(optional): array Items
  Title: Items

  The diagnostic actions attached to this monitor. Actions are relevant only for delegating and custom monitors. Valid actions are: TraceAction, DisplayArgumentsAction, MethodInvocationStatisticsAction, MethodMemoryAllocationStatisticsAction, StackDumpAction, ThreadDumpAction, TraceElapsedTimeAction, and TraceMemoryAllocationAction

• description(optional): string

  Optional description of this monitor.

• dyeFilteringEnabled(optional): boolean

  Specifies whether dye filtering is enabled for the diagnostic actions associated with this monitor.

• dyeMask(optional): string

  The dye mask for all diagnostic actions associated with this monitor.

• enabled(optional): boolean
  Default Value: true

  Specifies whether the monitor and its associated diagnostics actions are enabled.

• excludes(optional): array Items
  Title: Items

  Pattern expressions for classes that will be excluded for this instrumentation monitor. If specified, classes matching given patterns will not be instrumented with this monitor.

• id(optional): integer(int64)
  Read Only: true

  Return the unique id of this bean instance.

• includes(optional): array Items
  Title: Items

  Pattern expressions for classes that are included for this instrumentation monitor. If specified, only included classes will be instrumented with this monitor. If not specified, all classes loaded within the application and which are not explicitly excluded are eligible for instrumentation with this monitor.

  A pattern can end with an asterisk (), in which case it will match with all classes whose fully qualified classname starts with the prefix of the pattern. For example, weblogic.rmi.* will match with all classes in weblogic.rmi and its subpackages.

• locationType(optional): string
  Default Value: before

  Allowed Values: [ "before", "after", "around" ]

  Attached actions are applied at selected locations: before, after, or around pointcuts. This is relevant only for custom monitors. (A location where diagnostic code is added is called a diagnostic joinpoint. A set of joinpoints, identified by an expression, is called a pointcut.)

  Once a location type is set, it cannot be changed.

• name(optional): string
  Read Only: true

  The name of the WebLogic Diagnostic Framework (WLDF) bean.

• pointcut(optional): string

  The pointcut expression for this monitor. (A location where diagnostic code is added is called a diagnostic joinpoint. A set of joinpoints, identified by an expression, is called a pointcut.)

  Setting a pointcut expression is relevant only for custom monitors; for standard and delegating monitors, this definition is implicitly defined by WLDF.

  Once a pointcut expression is set, it cannot be changed.

• properties(optional): string

  Properties for this monitor. Properties are name=value pairs, one pair per line. For example, USER1=foo ADDR1=127.0.0.1

{
    "type":"object",
    "properties":{
        "actions":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>The diagnostic actions attached to this monitor. Actions are relevant only for delegating and custom monitors. Valid actions are: <code>TraceAction</code>, <code>DisplayArgumentsAction</code>, <code>MethodInvocationStatisticsAction</code>, <code>MethodMemoryAllocationStatisticsAction</code>, <code>StackDumpAction</code>, <code>ThreadDumpAction</code>, <code>TraceElapsedTimeAction</code>, and <code>TraceMemoryAllocationAction</code></p>"
        },
        "description":{
            "type":"string",
            "description":"<p>Optional description of this monitor.</p>"
        },
        "dyeFilteringEnabled":{
            "type":"boolean",
            "description":"<p>Specifies whether dye filtering is enabled for the diagnostic actions associated with this monitor.</p>"
        },
        "dyeMask":{
            "type":"string",
            "description":"<p>The dye mask for all diagnostic actions associated with this monitor.</p>"
        },
        "enabled":{
            "default":true,
            "type":"boolean",
            "description":"<p>Specifies whether the monitor and its associated diagnostics actions are enabled.</p>"
        },
        "excludes":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Pattern expressions for classes that will be excluded for this instrumentation monitor. If specified, classes matching given patterns will not be instrumented with this monitor.</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> Return the unique id of this bean instance.</p>"
        },
        "includes":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Pattern expressions for classes that are included for this instrumentation monitor. If specified, only included classes will be instrumented with this monitor. If not specified, all classes loaded within the application and which are not explicitly excluded are eligible for instrumentation with this monitor.</p><p>A pattern can end with an asterisk (<code></code>), in which case it will match with all classes whose fully qualified classname starts with the prefix of the pattern. For example, <code>weblogic.rmi.*</code> will match with all classes in <code>weblogic.rmi</code> and its subpackages.</p>"
        },
        "locationType":{
            "default":"before",
            "enum":[
                "before",
                "after",
                "around"
            ],
            "type":"string",
            "description":"<p>Attached actions are applied at selected locations: <code>before</code>, <code>after</code>, or <code>around</code> pointcuts. This is relevant only for custom monitors. (A location where diagnostic code is added is called a diagnostic joinpoint. A set of joinpoints, identified by an expression, is called a pointcut.)</p><p>Once a location type is set, it cannot be changed.</p>"
        },
        "name":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The name of the WebLogic Diagnostic Framework (WLDF) bean.</p>"
        },
        "pointcut":{
            "type":"string",
            "description":"<p>The pointcut expression for this monitor. (A location where diagnostic code is added is called a diagnostic joinpoint. A set of joinpoints, identified by an expression, is called a pointcut.)</p><p>Setting a pointcut expression is relevant only for custom monitors; for standard and delegating monitors, this definition is implicitly defined by WLDF.</p><p>Once a pointcut expression is set, it cannot be changed.</p>"
        },
        "properties":{
            "type":"string",
            "description":"<p>Properties for this monitor. Properties are name=value pairs, one pair per line. For example, <code>USER1=foo\nADDR1=127.0.0.1</code></p>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

The diagnostic actions attached to this monitor. Actions are relevant only for delegating and custom monitors. Valid actions are: TraceAction, DisplayArgumentsAction, MethodInvocationStatisticsAction, MethodMemoryAllocationStatisticsAction, StackDumpAction, ThreadDumpAction, TraceElapsedTimeAction, and TraceMemoryAllocationAction

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>The diagnostic actions attached to this monitor. Actions are relevant only for delegating and custom monitors. Valid actions are: <code>TraceAction</code>, <code>DisplayArgumentsAction</code>, <code>MethodInvocationStatisticsAction</code>, <code>MethodMemoryAllocationStatisticsAction</code>, <code>StackDumpAction</code>, <code>ThreadDumpAction</code>, <code>TraceElapsedTimeAction</code>, and <code>TraceMemoryAllocationAction</code></p>"
}

Nested Schema : Items

Type: array

Title: Items

Pattern expressions for classes that will be excluded for this instrumentation monitor. If specified, classes matching given patterns will not be instrumented with this monitor.

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Pattern expressions for classes that will be excluded for this instrumentation monitor. If specified, classes matching given patterns will not be instrumented with this monitor.</p>"
}

Nested Schema : Items

Type: array

Title: Items

Pattern expressions for classes that are included for this instrumentation monitor. If specified, only included classes will be instrumented with this monitor. If not specified, all classes loaded within the application and which are not explicitly excluded are eligible for instrumentation with this monitor.

A pattern can end with an asterisk (), in which case it will match with all classes whose fully qualified classname starts with the prefix of the pattern. For example, weblogic.rmi.* will match with all classes in weblogic.rmi and its subpackages.

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Pattern expressions for classes that are included for this instrumentation monitor. If specified, only included classes will be instrumented with this monitor. If not specified, all classes loaded within the application and which are not explicitly excluded are eligible for instrumentation with this monitor.</p><p>A pattern can end with an asterisk (<code></code>), in which case it will match with all classes whose fully qualified classname starts with the prefix of the pattern. For example, <code>weblogic.rmi.*</code> will match with all classes in <code>weblogic.rmi</code> and its subpackages.</p>"
}

Back to Top