Managing the Windchill Directory Server Logging
The Windchill Directory Server provides the following logs:
• access
• audit
• debug
• error
Each log, located in <WindchillDS>/server/logs, consists of a log publisher and a set of policies to determine the configuration of the log publisher. For example, the access log has a set of policies that determine the size of the logs and how long logs are retained. Each log has its own set of policies.
Server logging is configured with the command line utility dsconfig. The dsconfig utility is an interactive command line utility that prompts the user for input, or, if you provided the complete set of arguments, it can be run in non-interactive mode. Also, if you use dsconfig, you can modify the policies of each logger.
Listing the Current Log Publishers
The following example uses the interactive command-line mode of dsconfig to list the current log publishers. By default the access log, error log, and replication repair logger are enabled.
D:\<WindchillDS>\server\bat>dsconfig
>>>> Specify Windchill Directory Server LDAP connection parameters
Directory server hostname or IP address [my-host-name]:
How do you want to trust the server certificate?
1) Automatically trust
2) Use a truststore
3) Manually validate
Enter choice [3]: 1
Directory server administration port number [4444]:
Administrator user bind DN [cn=Directory Manager]: cn=Manager
Password for user 'cn=Manager':
>>>> Windchill Directory Server configuration console main menu
What do you want to configure?
1) Access Control Handler 24) Monitor Provider
2) Account Status Notification 25) Network Group Handler
3) Administration Connector 26) Network Group Criteria
4) Alert Handler 27) Network Group Request Filtering Policy
5) Attribute Syntax 28) Network Group Resource Limits
6) Backend 29) Password Generator
7) Certificate Mapper 30) Password Policy
8) Connection Handler 31) Password Storage Scheme
9) Crypto Manager 32) Password Validator
10) Debug Target 33) Plugin
11) Entry Cache 34) Plugin Root
12) Extended Operation Handler 35) Replication Domain
13) Extension 36) Replication Server
14) Global Configuration 37) Root DN
15) Group Implementation 38) Root DSE Backend
16) Identity Mapper 39) SASL Mechanism Handler
17) Key Manager Provider 40) Synchronization Provider
18) Local DB Index 41) Trust Manager Provider
19) Local DB VLV Index 42) Virtual Attribute
20) Log Publisher 43) Work Queue
21) Log Retention Policy 44) Workflow
22) Log Rotation Policy 45) Workflow Element
23) Matching Rule
q) quit
Enter choice: 20
>>>> Log Publisher management menu
What would you like to do?
1) List existing Log Publishers
2) Create a new Log Publisher
3) View and edit an existing Log Publisher
4) Delete an existing Log Publisher
b) back
q) quit
Enter choice [b]: 1
Log Publisher : Type : enabled
--------------------------:-------------------:--------
File-Based Access Logger : file-based-access : true
File-Based Audit Logger : file-based-access : false
File-Based Debug Logger : file-based-debug : false
File-Based Error Logger : file-based-error : true
Replication Repair Logger : file-based-error : true
Press RETURN to continue
Changing a Log Policy
The following is an example of changing the log retention policy. Changing the policy changes the maximum log file size.
What do you want to configure?
1) Access Control Handler 24) Monitor Provider
2) Account Status Notification 25) Network Group Handler
3) Administration Connector 26) Network Group Criteria
4) Alert Handler 27) Network Group Request Filtering Policy
5) Attribute Syntax 28) Network Group Resource Limits
6) Backend 29) Password Generator
7) Certificate Mapper 30) Password Policy
8) Connection Handler 31) Password Storage Scheme
9) Crypto Manager 32) Password Validator
10) Debug Target 33) Plugin
11) Entry Cache 34) Plugin Root
12) Extended Operation Handler 35) Replication Domain
13) Extension 36) Replication Server
14) Global Configuration 37) Root DN
15) Group Implementation 38) Root DSE Backend
16) Identity Mapper 39) SASL Mechanism Handler
17) Key Manager Provider 40) Synchronization Provider
18) Local DB Index 41) Trust Manager Provider
19) Local DB VLV Index 42) Virtual Attribute
20) Log Publisher 43) Work Queue
21) Log Retention Policy 44) Workflow
22) Log Rotation Policy 45) Workflow Element
23) Matching Rule
q) quit
Enter choice: 21
>>>> Log Retention Policy management menu
What would you like to do?
1) List existing Log Retention Policies
2) Create a new Log Retention Policy
3) View and edit an existing Log Retention Policy
4) Delete an existing Log Retention Policy
b) back
q) quit
Enter choice [b]: 1
Log Retention Policy : Type : disk-space-used : free-disk
-space : number-of-files
---------------------------------:-----------------:-----------------:----------
-------:----------------
File Count Retention Policy : file-count : - : -
: 10
Free Disk Space Retention Policy : free-disk-space : - : 500 mb
: -
Size Limit Retention Policy : size-limit : 500 mb : -
: -
Press RETURN to continue
>>>> Log Retention Policy management menu
What would you like to do?
1) List existing Log Retention Policies
2) Create a new Log Retention Policy
3) View and edit an existing Log Retention Policy
4) Delete an existing Log Retention Policy
b) back
q) quit
Enter choice [b]: 3
>>>> Select the Log Retention Policy from the following list:
1) File Count Retention Policy
2) Free Disk Space Retention Policy
3) Size Limit Retention Policy
c) cancel
q) quit
Enter choice [c]: 3
>>>> Configure the properties of the Size Limit Log Retention Policy
Property Value(s)
-------------------------
1) disk-space-used 500 mb
?) help
f) finish - apply any changes to the Size Limit Log Retention Policy
c) cancel
q) quit
Enter choice [f]: 1
>>>> Configuring the "disk-space-used" property
Specifies the maximum total disk space used by the log files.
Syntax: 1 b <= SIZE
Do you want to modify the "disk-space-used" property?
1) Keep the value: 500 mb
2) Change the value
?) help
q) quit
Enter choice [1]: 2
Enter a value for the "disk-space-used" property: 200 mb
Press RETURN to continue
>>>> Configure the properties of the Size Limit Log Retention Policy
Property Value(s)
-------------------------
1) disk-space-used 200 mb
?) help
f) finish - apply any changes to the Size Limit Log Retention Policy
c) cancel
q) quit
Enter choice [f]: f
The Size Limit Log Retention Policy was modified successfully
Press RETURN to continue
>>>> Log Retention Policy management menu
What would you like to do?
1) List existing Log Retention Policies
2) Create a new Log Retention Policy
3) View and edit an existing Log Retention Policy
4) Delete an existing Log Retention Policy
b) back
q) quit
Enter choice [b]: