NAME¶

sdagent.conf - Supportconfig Diagnostic Agent configuration file

DESCRIPTION¶

The sdagent.conf file has default values for variables used by several Agent Server applications. The following applications use the sdagent.conf file: sdagent, sdagent-supportconfig, sdagent-patterns.

GLOBAL VARIABLES¶

INSRC

Input source. The complete input source location of supportconfig archives to be processed. This URL is broken into individual components by sdagent-config for faster processing because sdagent and its worker threads are run frequently. The components are INSRC_TYPE, INSRC_HOST and INSRC_DIR.

INSRC_TYPE

Input source type. This is the type component of the INSRC. There are two supported input source types: ftp and file

INSRC_HOST

Input source host. This is the hostname component of the INSRC.

INSRC_DIR

Input source directory. This is the directory component of the INSRC.

OUTSRC

Output source. The complete output source location for HTML generated reports to be posted. This URL is broken into individual components by sdagent-config for faster processing because sdagent and its worker threads are run frequently. The components are OUTSRC_TYPE, OUTSRC_HOST and OUTSRC_DIR.

OUTSRC_TYPE

Output source type. This is the type component of the OUTSRC. There are two supported input source types: ftp and file

OUTSRC_HOST

Output source host. This is the hostname component of the OUTSRC.

OUTSRC_DIR

Output source directory. This is the directory component of the OUTSRC.

ARCH_LOCATION

The URL where archives are stored and follows the INSRC format.

AGENT_ID

The Agent Server's MySQL ID that identifies it in the database on the Broker Server.

AGENT_PRIORITY_GROUP

When multiple Agent Servers are processing archives, you may want some Agent Servers to handle most of the work, while others are backup in case the primary Agent Servers are too busy. The smaller the number the higher the priority. You can have multiple agents with the same priority number. This value causes the sdagent to delay assigning archives to its worker threads. The value is measured in seconds. So you might want two Agent Servers to wait 5 seconds before assigning archives, which would give Agent Servers with a lower priority access to the archives sooner.

DELAY_RETRY

The sdagent-supportconfig waits DELAY_RETRY seconds before attempting to download or upload files. It applies to ftp INSRC_TYPE and OUTSRC_TYPE only.

MAX_HOST_RETRY

The maximum number of retry attempts to connect to the ftp INSRC or OUTSRC waiting DELAY_RETRY seconds each time. By default the sdagent-supportconfig will attempt 6 times waiting 20 seconds each try when downloading or uploading files. If the agent worker thread fails to connect, it will mark the archive for retry. The archive will be reprocessed according to MAX_ARCHIVE_RETRY.

MAX_ARCHIVE_RETRY=8

The maximum number of times to retry an archive analysis. When an archive cannot be processed for some reason, the agent may attempt to retry the analysis. The number of times an archive has been retried is logged in the Archives table and the RetryCount field. Once that field value exceeds the MAX_ARCHIVE_RETRY, the agent will mark the archive with an Error and stop attempting the analysis.

MAX_DISK_HEALTH

The maximum percent of used disk space allowed before declaring the Agent Server unhealthy. The Agent Server will be marked inactive until disk space is freed and the agent reset using scadb(1).

MAX_ARCHIVE_SIZE

The maximum supportconfig archive size that will be considered for analysis. Archives greater than this size will be ignored. The value is file size in bytes.

POST_REPORT

When set to 1, the sdagent-supportconfig will build an HTML report file and post it into the OUTSRC directory.

ALL_PATTERNS

When an analysis pattern results in an error or not applicable result, it is excluded from the MySQL database. The inapplicable results are usually excluded because they take up too much space in the database. However, if you want them logged in the database, change this value to 1.

ARCHIVE_MODE

Once the sdagent-supportconfig downloads and processes the supportconfig archive, it usually deletes it. Setting this option to 1 tells the agent worker thread to keep the file on the local filesystem. Default: 0

SCA_WORK

The agent's home working directory.

SCA_PATTERN_PATH

The supportconfig pattern SVN repository directory. The perl patterns used to analyze the supportconfig text files are located here.

PATTERNS

The supportconfig pattern repository manifest. It contains a list of all the usable patterns found in SCA_PATTERN_PATH and is updated by sdagent-patterns(1).

BASHLIB

The Bash library location for the supportconfig pattern repository. The bash patterns sdagent-supportconfig uses requires bash libraries located in this directory.

PERL5LIB

The Perl library location for the supportconfig pattern repository. The perl patterns sdagent-supportconfig uses requires perl libraries located in this directory.

PYTHONPATH

The Python library location for the supportconfig pattern repository. The python patterns sdagent-supportconfig uses requires python libraries located in this directory.

EMAIL_ADMIN

The administrator email notification address. Any email alerts generated by sdagent or sdagent-supportconfig will be sent to this address.

EMAIL_REPORT

The report email notification address. If STATUS_NOTIFY_LEVEL is set, the HTML report file will be emailed to the EMAIL_REPORT user.

DB_USER

The MySQL database user for all Agent Server database operations. The sdagent user is included in the schema and created by default.

DB_PASS

The DB_USER password for the sdagent MySQL database user.

DB_NAME

The main MySQL database name for the Supportconfig Diagnostic Tool infrastructure located on the Broker Server.

DB_CONNECT

MySQL connection information. Includes the DB_USER, DB_PASS and DB_NAME necessary for the Agent Server to access the ServerDiagnostics database on the Broker Server.

LOGLEVEL

The agent log level. Valid options are LOGLEVEL_SILENT, LOGLEVEL_MIN, LOGLEVEL_NORMAL, LOGLEVEL_VERBOSE and LOGLEVEL_DEBUG.

EMAIL_LEVEL

The level of alerts sent to the administrator's email. Valid options are EMAIL_SILENT, EMAIL_MIN, EMAIL_NORMAL, EMAIL_VERBOSE and EMAIL_DEBUG.

STATUS_NOTIFY_LEVEL

The minimum severity level required to justify sending an email report to the EMAIL_REPORT user. Valid options in order from least to greatest are STATUS_OFF, STATUS_SUCCESS, STATUS_RECOMMEND, STATUS_WARNING and STATUS_CRITICAL.

AUTHOR¶

Jason Record <jrecord@suse.com>

COPYRIGHT¶

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; version 2 of the License.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, see <http://www.gnu.org/licenses/>.

SEE ALSO¶

sdagent(8) sdagent-supportconfig(8) sdagent-config(8)