Working with trace service properties files

You can use properties files to create or change trace service properties and the associated trace log under a server.

Before you begin

Determine the changes that you want to make to your trace service configuration or its configuration objects.

Start the wsadmin scripting tool. To start wsadmin using the Jython language, run the wsadmin -lang jython command from the bin directory of the server profile.

Note: This topic references one or more of the application server log files. As a recommended alternative, you can configure the server to use the High Performance Extensible Logging (HPEL) log and trace infrastructure instead of using SystemOut.log , SystemErr.log, trace.log, and activity.log files on distributed and IBM® i systems. You can also use HPEL in conjunction with your native z/OS® logging facilities. If you are using HPEL, you can access all of your log and trace information using the LogViewer command-line tool from your server profile bin directory. See the information about using HPEL to troubleshoot applications for more information on using HPEL.

About this task

Using a properties file, you can create, modify, or delete a trace service object and its configuration properties.

Run administrative commands using wsadmin to change a properties file for a trace service, validate the properties, and apply them to your configuration.

Table 1. Actions for trace service properties files . You can create, modify, and delete trace service properties.
Action	Procedure
create	Not applicable
modify	Edit properties and then run the applyConfigProperties command.
delete	Not applicable
create Property	Set properties and then run the applyConfigProperties command.
delete Property	Specify the properties to delete in the properties file and then run the deleteConfigProperties command.

Optionally, you can use interactive mode with the commands:

AdminTask.command_name('-interactive')

Procedure

Create trace service properties.

Specify TraceService properties in a properties file.

Open an editor and specify trace service properties and an associated TraceLog under a server in a properties file. You can copy the following example properties into an editor and modify the properties as needed for your situation. The example shows a property under TraceService with name myName and value myVal.

#
# Header
#
ResourceType=TraceService
ImplementingResourceType=GenericType
ResourceId=Cell=!{cellName}:Node=!{nodeName}:Server=!{serverName}:TraceService=
AttributeInfo=services
#

#
#Properties
#
startupTraceSpecification="*=info"
enable=true #boolean,default(false)
context=!{serverName}
memoryBufferSize=8 #integer,required,default(8)
traceFormat=BASIC #ENUM(LOG_ANALYZER|BASIC|ADVANCED),default(BASIC)
traceOutputType=SPECIFIED_FILE #ENUM(SPECIFIED_FILE|MEMORY_BUFFER),default(MEMORY_BUFFER)


#
# Header
#
ResourceType=TraceLog
ImplementingResourceType=GenericType
ResourceId=Cell=!{cellName}:Node=!{nodeName}:Server=!{serverName}:TraceService=:TraceLog=
AttributeInfo=traceLog
#

#
#Properties
#
maxNumberOfBackupFiles=5 #integer,default(1)
rolloverSize=20 #integer,default(100)
fileName="${SERVER_LOG_ROOT}/trace.log"


#
# Header
#
ResourceType=TraceService
ImplementingResourceType=GenericType
ResourceId=Cell=!{cellName}:Node=!{nodeName}:Server=!{serverName}:TraceService=
AttributeInfo=properties(name,value)
#
#
#Properties
myName=myVal
#

#
EnvironmentVariablesSection
#
#Environment Variables
cellName=WASCell06
serverName=myServer
nodeName=WASNode04

Run the applyConfigProperties command to create a TraceService configuration.
Running the applyConfigProperties command applies the properties file to the configuration. In this Jython example, the optional -reportFileName parameter produces a report named report.txt:
```
AdminTask.applyConfigProperties(['-propertiesFileName myObjectType.props -reportFileName report.txt'])
```

Modify existing trace service or associated TraceLog properties.
1. Obtain a properties file for the trace service that you want to change.
  You can extract a properties file for a TraceService using the extractConfigProperties command.
2. Open the properties file in an editor and change the properties as needed.
  Ensure that the environment variables in the properties file match your system.
3. Run the applyConfigProperties command.
Delete the trace service properties.
To delete one or more properties, specify only those properties to delete in the properties file and run deleteConfigProperties.
```
AdminTask.deleteConfigProperties('[-propertiesFileName myObjectType.props -reportFileName report.txt]') 
```

Results

You can use the properties file to configure and manage the trace service object.

What to do next

Save the changes to your configuration.