Working with category debug logging
You can enable debug logging for specific categories at run time. Category debug logging makes problem diagnosis easier by enabling you to target logging to specific BMC Cloud Lifecycle Management modules and to specify the level of detail that is reported in the logs.
To enable category debug logs
- Log on to the server that hosts Platform Manager.
- Open cloudservices.json in a text editor.
The file is located in the following directory:- Windows: C:\Program Files\BMC Software\BMCCloudLifeCycleManagement\Platform_Manager\configuration
- Linux: /opt/bmc/BMCCloudLifeCycleManagement/Platform_Manager/configuration
- Search for the following text string:
Logging Service
This search positions you at the section in the file that contains access attributes for the Logging Service. If the
categoryDebugLevelsaccess attribute value object is not present in the Logging Service section of the file, copy the following JSON and paste it into the file within theaccessValuesobject of the Logging ServiceCloudServiceobject; otherwise, skip to the next step.{ "cloudClass": "com.bmc.cloud.model.beans.AccessAttributeValue", "accessAttribute": { "cloudClass": "com.bmc.cloud.model.beans.AccessAttribute", "datatype": "String", "description": "Debug Level per Category", "guid": "BB14C628-E602-4BAA-9BAE-AD616280B516", "isOptional": true, "isPassword": false, "length": 255, "modifiableWithoutRestart": true, "name": "categoryDebugLevels" }, "attributeValue": "EFM=debug,TASK=debug", "description": "Debug Level per Category", "guid": "48591A8B-E887-4F1E-B8DA-AE231D2B7727", "name": "categoryDebugLevels" }To view sample excerpts from the cloudservices.jsonfile that will help you position the JSON correctly, click the following disclosure triangles:
Within the
categoryDebugLevelsaccess attribute value object, modifyattributeValueto specify the categories that you want to log.
The value forattributeValueis a string of comma-separated key-value pairs in the format CATEGORY=level. In each key-value pair, CATEGORY represents the name for a module or group of modules within the software and level represents the log level to apply to the category. See Log levels and Categories for the values that you can use. See Examples for some sampleattributeValuesettings.
You can specify different categories at different log levels. For example, to select info-level logging for the EFM category, debug-level logging for the TASK category, and error-level logging for the WLM category, enter the following value forattributeValue:"attributeValue" : "EFM=info,TASK=debug,WLM=error",- Save the cloudservices.json file.
The new setting is effective in 5 seconds. You do not need to restart Platform Manager.
Log levels
The following table describes the log levels that you can specify:
Log level | Description |
|---|---|
| Logs detailed information that provides insight into the sequence of events |
| Logs severe errors, runtime errors, and unexpected conditions |
| Logs interesting runtime events, such as starting or stopping services and creating or deleting important objects |
| Logs undesirable runtime conditions, such as poor use of APIs and use of deprecated APIs |
Categories
The following table lists the categories for which you can enable logging and the modules that correspond to each category. If a particular module that you want to log does not appear in the list, use the default category, GENERAL.
Category | Category | Modules |
|---|---|---|
1 | GENERAL (default) | ARMapManager, Policy, Cache, HostnameProvider, Util |
2 | DB | CloudDB |
3 | REGISTRY | Local registry, global registry |
4 | API | CloudManagerService, BBSA, BBNA, BCM, BPPM, parts in RM |
5 | TASK | TaskManager, Helper classes in EFM, WLM, RM |
6 | Not used | Not applicable |
7 | RESOURCE_MANAGER | RM and Helpers in BCM Provider |
8 | EFM | EFM |
9 | WLM | WLM |
10 | PROVIDER_REGISTRY | Provider Registry |
11 | PROVIDER | Base Provider and provider initialization part in all providers |
12 | OBJECT_MODEL | OM |
13 | LOGIN_SERVICE | Login Service |
14 | SESSION_MANAGER | Session manager |
15 | CACHE | Cache |
16 | GENERIC_PROVIDER | Generic Provider |
17 | CALLOUT | Callhandler, callout |
18 | ARMAPMANAGER | ARMap Manager |
19 | VCLOUD | VCD |
20 | API_VALIDATOR | Provider Registry |
21 | MIGRATION | Migration framework, migration tasks |
22 | UTIL | Util |
23 | SCHEDULER | Scheduler |
Examples
The following table contains examples of strings that you can use for attributeValue in the categoryDebugLevels access attribute value object:
Purpose | Setting for |
|---|---|
To see task results, callbacks, and general debugging information |
|
To debug the provisioning flow |
|
To debug CloudDB related issues |
|
To debug provider registration and request routing (provider registry) issues |
|
To debug BMC Server Automation, BMC Network Automation, and other proxy provider issues |
|
To disable category debug logs
- Log on to the server that hosts Platform Manager.
- Open cloudservices.json in a text editor.
The file is located in the following directory:- Windows: C:\Program Files\BMC Software\BMCCloudLifeCycleManagement\Platform_Manager\configuration
- Linux: /opt/bmc/BMCCloudLifeCycleManagement/Platform_Manager/configuration
- Find the
categoryDebugLevelsaccess attribute value object. Remove the debug level options from the
attributeValueobject by setting the value as follows:"attributeValue": "",- Save the cloudservices.json file.
Comments
Log in or register to comment.