pi.conf

The pi.conf file controls the operation of the Platform Analytics server.

About pi.conf

pi.conf specifies the configuration of various Platform Analytics server components and features.

Changing pi.conf configuration

After making any changes to pi.conf, run the following commands from the ANALYTICS_TOP/bin directory to restart the Platform Analytics server and apply your changes:

perfadmin stop all

perfadmin start all

Location

The location of pi.conf is in ANALYTICS_TOP/conf.

Format

Each entry in pi.conf has the following form:
NAME=VALUE

The equal sign = must follow each NAME and there should be no space beside the equal sign. Text starting with a pound sign (#) are comments and are ignored. Do not use #if as this is reserved syntax for time-based configuration.

PIAM_PORT

Syntax

PIAM_PORT=port_number

Description

Specifies the Platform Automation Manager listening port number.

Default

9991

CHECK_INTERVAL

Syntax

CHECK_INTERVAL=time_in_seconds

Description

Specifies the interval, in seconds, that the Platform Automation Manager checks the system.

Default

60 seconds

send_notifications

Syntax

send_notifications=true | false

Description

Enables event notification.

You would normally configure this parameter using the Platform Analytics Console (in the navigation tree, click Events, then right-click on the list of events and select Action > Notification).

If set to true, Platform Analytics sends an event notification email when it encounters a change in state that matches the event notification settings. An event notification email informs the you of the change in state in Platform Analytics or the cluster, allowing you to decide whether you want to check the Platform Analytics Console for further details.

For more information on event notification, refer to Event notification.

Default

true

mail.smtp.host

Syntax

mail.smtp.host=host_name.domain_name

Description

Specifies the SMTP server that Platform Analytics uses to send event notification emails.

You would normally configure this parameter using the Platform Analytics Console (in the navigation tree, click Events, then right-click on the list of events and select Action > Notification).

Example

mail.smtp.host=smtp.example.com

Valid values

Any fully-qualified SMTP server name.

Default

Not defined.

from_address

Syntax

from_address=email_account

Description

Specifies the sender email address that Platform Analytics uses to send event notification emails.

You would normally configure this parameter using the Platform Analytics Console (in the navigation tree, click Events, then right-click on the list of events and select Action > Notification).

Example

from_address=system@example.com

Default

Not defined

to_address

Syntax

to_address=email_account

Description

Specifies the email addresses of the intended recipient of the event notification emails that Platform Analytics will send.

You would normally configure this parameter using the Platform Analytics Console (in the navigation tree, click Events, then right-click on the list of events and select Action > Notification).

Example

to_address=admin@example.com

Default

Not defined

subject_text

Syntax

subject_text=text

Description

Specifies the subject of the event notification emails that Platform Analytics will send.

You would normally configure this parameter using the Platform Analytics Console (in the navigation tree, click Events, then right-click on the list of events and select Action > Notification).

Example

subject_text=Platform Platform Analytics Error Notification

Default

Not defined

message_header

Syntax

message_header=text

Description

Specifies the header of the event notification emails that Platform Analytics will send. The rest of the email contains information about the event change and is not specified here.

You would normally configure this parameter using the Platform Analytics Console (in the navigation tree, click Events, then right-click on the list of events and select Action > Notification).

Example

message_header=An error has occurred in the Platform Platform Analytics data collection system.

Default

Not defined

PIEM_PORT

Syntax

PIEM_PORT=port_number

Description

Specifies the Platform Event Manager listening port number.

Default

37600

PIEM_HOST

Syntax

PIAM_PORT=port_number

Description

Specifies the Platform Event Manager host.

Default

localhost

PIEM_TIMEOUT

Syntax

PIEM_TIMEOUT=time_in_seconds

Description

Specifies the timeout, in seconds, for Platform Event Manager to receive events.

Default

36000 seconds (10 hours)

EVENTLOGGER_TIMEOUT

Syntax

EVENTLOGGER_TIMEOUT=time_in_seconds

Description

Specifies the timeout, in seconds, for the Platform Event Manager client to send event notifications.

Default

5 seconds

EVENT_LEVEL

Syntax

EVENT_LEVEL=ALL | TRACE | DEBUG | INFO | WARN | ERROR | FATAL | OFF

Description

Specifies the logging levels of events to send to the Platform Event Manager. All events of this specified level or higher are sent. In decreasing level of detail, these are TRACE, DEBUG, INFO, WARN, ERROR, and FATAL.

Use ALL to specify all messages and OFF to specify no messages.

Example

EVENT_LEVEL=WARN

All WARN, ERROR, and FATAL messages are sent to Platform Event Manager.

Default

INFO

All INFO, WARN, ERROR, and FATAL messages are sent to Platform Event Manager.

DS_NAME

Syntax

DS_NAME=data_source_name

Description

Specifies the name of the data source for the Platform Event Manager to access.

Default

ReportDB

PURGER_BATCH_SIZE

Syntax

PURGER_BATCH_SIZE=integer

Description

Specifies the number of records to purge in each batch.

Valid values

Any positive integer

Default

10000000

SHOW_BUSINESS_INFO

Syntax

SHOW_BUSINESS_INFO=YES | Y | NO | N

Description

Specify YES or Y to enable the Data Collection Nodes page in the Platform Analytics Console to display the following optional columns:

  • System Purpose

  • Display Description

  • Business Area

Default

YES