Copyright © 1999-2023. Cloud Software Group, Inc. All Rights Reserved.

Custom Log Sink Reference

The Log Sinks folder allows you to configure advanced logging behavior.

For basic logging behavior, use the Logging tab of the adapter instance. See Logging Tab.

This discusses the following log sink topics:

•	Log Sinks Overview

•

File Sink

•	stdio Sink

•	Network Sink

•

Hawk Sink

•	Adding Roles to Sinks

Log Sinks Overview

The TIBCO Adapter SDK allows programmers to define traces with different roles and sends them to sinks with the corresponding role.

You can fine-tune where and when different types of information are sent. First you use TIBCO Designer to define sinks and map each sink to one or more roles.

Each time the program calls a tracing method, it has to explicitly or implicitly specify one or more roles. Each sink that has been mapped to that role receives that message if the role has been turned on. This way, the output information level can be tuned via modifications to the adapter configuration. To reduce the amount of information, roles can be turned off for the adapter configuration using TIBCO Designer.

Four types of sinks are predefined and configurable from the Log Sinks folder. They are discussed in this chapter:

•

File Sink

•	stdio Sink

•	Network Sink

•

Hawk Sink

You can also define a sink that uses a custom role. This is discussed in Adding Roles to Sinks.

File Sink

For a file sink, you specify the following information:

Table 60 File Sink

Name	Sink name of this file sink.
File Name	Global variable that includes the path and name of trace file. Extension .log is suggested.
File Limit (bytes)	Maximum size of the file, in bytes. Default is 30000. Maximum is 2147483647 bytes.
File Count	Number of rollover files. Default is 3.
Append Mode	If checked, traces are added to the existing file at startup. If unchecked, the existing file is overwritten at startup if one of the same name exists. Only true and false are legal values.
Description	Optional description of this file sink.

The default file sink that is part of each adapter has those roles predefined that were selected when you turned on Advanced Logging. If you create additional file sinks, you can add roles. See Adding Roles to Sinks

Understanding File Count and File Limit

If you have specified a file sink in your configuration, your SDK-based adapter will go through these steps:

1.	Creates a file with no extension using the specified filename.

2.	Writes to that file until it reaches the size specified in File Limit.

3.	When File Limit has been reached (that is, as soon as the file is as big as or bigger than the limit) the adapter renames the current file to file.1 and creates a new file with no extension.

4.	Note that the log file can be slightly larger than the limit because the new file is only created after the limit has been reached.

5.	The adapter repeats this process until it reaches the number of files specified in File Count.

The adapter overwrites the file with the highest number, that is, the oldest file, when the number of files reaches File Count and that last file reaches File Limit. To avoid that, set either File Count or File Limit to a sufficiently large value.

stdio Sink

For a stdio Sink, you specify the following information.

Table 61 stdio Sink

Name	Name of this sink.
Output Stream	Select stdio or stderr. If you select stderr, it remains selected even when you turn off Advanced Logging.
Description	Optional description of this sink.

Network Sink

To add a network sink:

1.	Select the Log Sinks panel.

2.	Drag a Generic Log Sink into the design panel.

3.	In the configuration panel, choose Network from the pop-up menu.

4.	Specify the network sink’s attributes.

Name	Sink name of this network sink.
Session	Click the Browse icon and select one of the sessions you defined.
Subject	Subject of TIBCO Rendezvous messages to be sent.
Description	Optional description of this sink.

5.	Add roles. See Adding Roles to Sinks.

Hawk Sink

A Hawk sink sends messages to TIBCO Hawk. To add a Hawk sink:

1.	Select the Log Sinks panel.

2.	Drag a Generic Log Sink into the design panel.

3.	In the configuration panel, choose Hawk from the pop-up menu.

4.	Specify the Hawk sink’s attributes.

Table 62 Hawk Sink

Name	Name of this Hawk sink.
MicroAgent Name	Name of the microagent for traces from this Hawk sink.
Description	Optional description of the sink.

5.	Add roles. See Adding Roles to Sinks.

Adding Roles to Sinks

For sinks that were defined for the adapter before Advanced Logging was turned on, one Role resource is included for each role that was turned on.

If you wish to add additional roles, or if you wish to add roles to newly created sinks, you have the following options:

To use an existing role, control-drag it into the sink.

To create a new role, follow these steps:

1.	Select the sink and drag a Generic Role into the design panel.

2.	If you wish to add a custom role, type the name of the role into the available field and press Enter, then click Apply.

3.	If you wish to add one of the predefined roles, choose the role from the pop-up, then click Apply.

Copyright © 1999-2023. Cloud Software Group, Inc. All Rights Reserved.