1 of 22

Choosing What an Action Does

Do Element

This section outlines the default modules used to specify AMPS behavior when an action is executed, using the Do element.

Rotate Error/Event Log

AMPS provides the following module for rotating log files and loads this module by default:

Module Name

Does

amps-action-do-rotate-logs

Rotates logs that are older than a specified age, for log types that support log rotation. Rotating a log involves closing the log and opening the next log in sequence.

AMPS will use the name specifier provided in the AMPS configuration for the new log file. This may overwrite the current log file if the specifier results in the same name as the current log file.

This module does not require options.

This module does not add any variables to the AMPS context.

Compress Files

AMPS provides the following module for compressing files. Use this action to compress error log files that are no longer needed. AMPS loads this module by default.

This action compresses files that match an arbitrary pattern. The original file is removed once the file is compressed. If the pattern is not specified carefully, this action can compress files that contain important data, are required for AMPS, or are required by the operating system.

This action cannot be used to safely compress journal files (also known as transaction log files). Use the actions described in Manage Transaction Log Journal Files for these files.

Module Name

Does

amps-action-do-compress-files

Compresses files that match the specified pattern that are older than the specified age. This action accepts an arbitrary pattern, and compresses files that match that pattern. While AMPS attempts to protect against deleting journal files, using a pattern that compresses files that are critical for AMPS, for the application, or for the operating system may result in loss of data.

The module does not recurse into directories. It skips open files. The module does not compress AMPS journals (that is, files that end with a .journal extension), and reports an error if a file with that extension matches the specified Pattern.

The commands to compress files are executed with the current permissions of the AMPS process.

This module requires an Age parameter that specifies the age of the files to remove, as determined by the update to the file. This module also requires a Pattern parameter that specifies a pattern for locating files to remove.

Parameter

Description

Age (required)

Specifies the age of files to process.

The module removes any file older than the specified Age that matches the specified Pattern.

For example, when the Age is 5d, only files that have not been modified within 5 days and that match the pattern will be processed by the module.

There is no default for this parameter.

Pattern (required)

Specifies the pattern for files to remove.

The module removes any files that match the specified Pattern that have not been modified more recently than the specified Age.

This parameter is interpreted as a Unix shell globbing pattern. It is not interpreted as a regular expression.

As with other parameters that use the file system, when the pattern specified is a relative path, the parameter is interpreted relative to the current working directory of the AMPS process. When the pattern specified is an absolute path, AMPS uses the absolute path.

There is no default for this parameter.

Keep

Specifies the number of files that meet the Age and Pattern criteria to leave uncompressed.

When this parameter is specified, AMPS will compress files matching the criteria, starting with the oldest files, and stop when the number of remaining files is the number specified in this parameter.

There is no default for this parameter. When both Keep and Count are specified, AMPS will not compress any files if the number of files meeting the criteria is less than the number specified in the Keep parameter.

Count

Specifies the maximum number of files that meet the Age and Pattern criteria to compress.

AMPS will compress files matching the criteria, starting with the oldest files, and stop when the number of files specified in this parameter have been compressed.

This module does not add any variables to the AMPS context.

Truncate Statistics

AMPS provides the following modules for managing the statistics database. As a maintenance strategy, 60East recommends truncating statistics on a regular basis. This frees space in the database file, which will be reused as new statistics are generated. It is generally not necessary to vacuum statistics unless you have changed your retention policy so that less data is retained between truncation operations. With regular truncation, the statistics database file will usually stabilize at the correct size to hold the amount of data your application generates between truncation operations.

AMPS loads these modules by default.

Module Name

Usage

amps-action-do-truncate-statistics

Removes statistics that are older than a specified age.

This frees space in the statistics file, but does not reduce the size of the file.

amps-action-do-vacuum-statistics

Deprecated

This action has been deprecated in current versions of AMPS and will no longer vacuum statistics. 60East recommends offline maintenance of the statistics database instead.

See the section on AMPS Statistics, in the AMPS User Guide, for details on shrinking the size of a statistics database.

The amps-action-do-truncate-statistics module requires an Age parameter that specifies the age of the statistics to process.

Parameter

Description

Age (required)

Specifies the age of the statistics to remove. The module processes any file older than the specified Age. For example, when the Age is 5d, the module removes statistics that are older than 5 days.

There is no default for this parameter.

These modules do not add any variables to the AMPS context.

Manage Transaction Log Journal Files

AMPS provides the following modules for managing journal files and loads these modules by default:

Module Name

Does

amps-action-do-archive-journal

Archives journal files that are older than a specified age to the JournalArchiveDirectory specified for the transaction log.

This action marks files to be archived and then returns.

amps-action-do-compress-journal

Compresses journal files that are older than a specified age.

This action marks files to be compressed and then returns.

amps-action-do-remove-journal

Deletes journal files that are older than a specified age.

This action marks files to be deleted and then returns.

If a journal file is currently in use, it will be removed when it is no longer in use.

AMPS will only remove journal files that are no longer needed by the instance. AMPS ensures that all replays from a journal file are complete, all queue messages in that journal file have been delivered (and acknowledged, if required), and all messages from a journal file have been successfully replicated before removing the file.

Journal files that have been compressed or archived (or both) are still part of the transaction log. AMPS will compress and archive journal files that have undelivered queue messages, or that have not yet been fully replicated, and so on.

Each of these modules requires an Age parameter that specifies the age of the journal files to process.

Parameter

Description

Age (required)

Specifies the age of files to process. The module processes any file older than the specified Age.

For example, when the Age is 5d, only files that have not been written to for longer than 5 days will be processed by the module.

AMPS does not remove the current journal file or files that are being used for replay, files that are being used for replication or files that contain unacknowledged and unexpired messages in a queue; even if the file is older than the Age parameter.

AMPS does not allow gaps in the journal files, so it will only remove a given file if all previous files have been removed.

AMPS can compress and archive journal files that are still in use since compressed or archived journal files are part of the transaction log and AMPS will replay messages from these files.

There is no default for this parameter.

These modules do not add any variables to the AMPS context.

Remove Files

AMPS provides the following module for removing files. Use this action to remove error log files that are no longer needed. AMPS loads this module by default.

This action removes files that match an arbitrary pattern. If the pattern is not specified carefully, this action can remove files that contain important data, are required for AMPS, or are required by the operating system.

This action cannot be used to safely remove journal files (also known as transaction log files). Use the actions described in Manage Transaction Log Journal Files for these files.

Module Name

Does

amps-action-do-remove-files

Removes files that match the specified pattern that are older than the specified age. This action accepts an arbitrary pattern, and removes files that match that pattern. While AMPS attempts to protect against deleting journal files, using a pattern that removes files that are critical for AMPS, for the application, or for the operating system may result in loss of data.

The module does not recurse into directories. It skips open files. The module does not remove AMPS journals (that is, files that end with a .journal extension), and reports an error if a file with that extension matches the specified Pattern.

The commands to remove files are executed with the current permissions of the AMPS process.

Parameter

Description

Age (required)

Specifies the age of files to process. The module removes any file older than the specified Age that matches the specified Pattern.

For example, when the Age is 5d, only files that have not been modified within 5 days and that match the pattern will be processed by the module.

There is no default for this parameter.

Pattern (required)

Specifies the pattern for files to remove. The module removes any files that match the specified Pattern that have not been modified more recently than the specified Age.

This parameter is interpreted as a Unix shell globbing pattern. It is not interpreted as a regular expression.

There is no default for this parameter.

Keep

Specifies the number of files that meet the Age and Pattern criteria to retain. When this parameter is specified, AMPS will remove files matching the criteria, starting with the oldest files, and stop when the number of remaining files is the number specified in this parameter.

There is no default for this parameter. When both Keep and Count are specified, AMPS will not remove any files if the number of files meeting the criteria is less than the number specified in the Keep parameter.

Count

Specifies the maximum number of files that meet the Age and Pattern criteria to remove. AMPS will remove files matching the criteria, starting with the oldest files, and stop when the number of files specified in this parameter have been removed.

This module does not add any variables to the AMPS context.

Delete SOW Messages

AMPS also provides modules for deleting SOW contents. The amps-action-do-delete-sow module deletes messages from the specified SOW topic.

This module requires the Topic, MessageType and Filter parameters in order to delete the desired message.

Parameter

Description

Topic (required)

The name of the SOW topic from which to delete messages.

This parameter supports regular expressions.

There is no default for this parameter.

MessageType (required)

The message type of the SOW topic or topics to delete from.

There is no default for this parameter.

Filter (required)

Set the filter to apply.

Only messages matching that filter will be deleted.

This module does not add any variables to the AMPS context.

Compact SOW Topic

AMPS also provides a module for reducing the unused space in a SOW file. The amps-action-do-compact-sow module rearranges the messages in the SOW into a smaller amount of space, where possible. Since AMPS uses memory-mapped files to store messages for the SOW topic, this can also potentially reduce the memory footprint of the topic.

This module can compact a specific SOW file or the SOW files for every topic in the instance.

While messages are being added or updated within a topic in the SOW, AMPS reuses free space when possible. It is not necessary to compact the SOW file during most normal operations. This action is most useful after an activity peak that leaves a large amount of unneeded space in the file, or in installations where space is at a premium. Depending on the file size, the number of topics to be compacted, and the amount of free space, the reorganization that this operation performs may require a noticeable amount of I/O bandwidth.

60East recommends that this action run during a maintenance window or in response to a critical lack of disk space. This operation will pause updates to the topic while it is being compacted, reducing overall throughput even if the compaction process runs quickly.

When a Topic and MessageType are provided, this module compacts the SOW file for that topic. Otherwise, the module compacts the file for all topics in the SOW.

Parameter

Description

Topic

The name of the SOW topic from which to compact.

This option must be specified if the MessageType is provided.

There is no default for this parameter.

MessageType

The message type of the SOW topic or topics to compact.

This option must be specified if the Topic is provided.

There is no default for this parameter.

This module does not add any variables to the AMPS context.

Query SOW Topic

AMPS provides a module for querying a SOW topic. The amps-action-do-query-sow queries the SOW topic, and stores the first message returned by the SOW query into a user-defined variable.

This module requires the Topic, MessageType and Filter parameters to identify the query to run. This module requires the CaptureData parameter in order to be able to store the result of the query.

Parameter

Description

Topic (required)

The name of the topic to query.

This topic must be a SOW topic, a view, a queue, or a conflated topic.

There is no default for this parameter.

This parameter supports regular expressions.

MessageType (required)

The message type of the topic to query.

There is no default for this parameter

Filter (required)

Set the filter to apply.

If a Filter is present, only messages matching that filter will be returned by the query.

CaptureData (required)

Sets the name of the variable within which AMPS will store the first message returned.

DefaultData

If no records are found, AMPS stores the DefaultData in the variable specified by CaptureData.

OrderBy

An OrderBy expression to use to order the results returned by the query.

For example, to order in descending order of the /date field in the messages, you would provide an OrderBy option of /date DESC.

Options

The options for the query.

This action accepts any valid option for a sow command except the top_n option (since this action is already limited to a top_n value of 1).

Once you query a message from the SOW topic, you can use the captured data in other actions. The example below uses amps-action-do-query-sow to query the SOW on a schedule in order to echo messages to the log for diagnostic purposes:

<Actions>
    <Action>
        <On>
            <Module>amps-action-on-schedule</Module>
            <Options>
                <Every>Saturday at 23:59</Every>
                <Name>Diagnostic_Schedule</Name>
            </Options>
        </On>
        <Do>
            <Module>amps-action-do-query-sow</Module>
            <Options>
                <MessageType>xml</MessageType>
                <Topic>SOW_TOPIC</Topic>
                <Filter>/Trans/Order/@Oname = 'PURCHASE'</Filter>
                <CaptureData>AMPS_DATA</CaptureData>
            </Options>
        </Do>
        <Do>
            <Module>amps-action-do-extract-values</Module>
            <Options>
                <MessageType>xml</MessageType>
                <Data>{{AMPS_DATA}}</Data>
                <Value>SAVED_VARIABLE=/Value</Value>
            </Options>
        </Do>
        <Do>
            <Module>amps-action-do-echo-message</Module>
            <Options>
                <Message>{{SAVED_VARIABLE}} was in the message</Message>
            </Options>
        </Do>
    </Action>
</Actions>

Manage Security

AMPS provides modules for managing the security features of an instance.

Authentication and entitlement can be enabled or disabled, which is useful for debugging or auditing purposes. You can also reset security and authentication, which clears the AMPS internal caches and gives security and authentication modules the opportunity to reinitialize themselves, for example, by re-parsing an entitlements file.

AMPS loads the following modules by default:

Module Name

Does

amps-action-do-disable-authentication

Disables authentication for the instance.

amps-action-do-disable-entitlement

Disables entitlement for the instance.

amps-action-do-enable-authentication

Enables authentication for the instance.

amps-action-do-enable-entitlement

Enables entitlement for the instance.

amps-action-do-reset-authentication

Resets authentication by clearing AMPS caches and reinitializing authentication.

amps-action-do-reset-entitlement

Resets entitlement by clearing AMPS caches and reinitializing entitlement.

These modules require no parameters. The amps-action-do-reset-authentication module and the amps-action-do-reset-entitlement module accept an optional Transport parameter which specifies the transport to reset.

Parameter

Description

Transport

The name of the transport for which to reset authentication or entitlements.

If no name is provided, these modules affect all transports.

AuthenticationId

The authentication ID of the client for which to reset entitlements.

If no ID is provided, these modules affect all clients.

These modules do not add any variables to the AMPS context.

Enable or Disable Transports

AMPS provides modules that can enable and disable specific transports. The amps-action-do-enable-transport module enables a transport. The amps-action-do-disable-transport module disables a transport.

Module Name

Does

amps-action-do-enable-transport

Enables a specific transport.

amps-action-do-disable-transport

Disables a specific transport.

Both modules require the name of the transport to disable or enable.

Parameter

Description

Transport

The name of the transport to enable or disable.

If no name is provided, the module affects all transports.

Both modules do not add any variables to the AMPS context.

Publish Message

The amps-action-do-publish-message module publishes a message into a specified topic.

Publishes from this action are treated as publishes from an AMPS client inside the AMPS engine. This means that:

There are no user credentials associated with the publish, so entitlements are not applied.
There is no special handling for the publish. The publish is recorded in the transaction log exactly as if it arrived from outside of the instance and is processed within the instance as if the publish had arrived from an external publisher.

This action is treated by the AMPS engine as a publish from an internal AMPS client. When an amps-action-do-publish-message runs in response to the amps-action-on-publish-message event or the amps-action-on-deliver-message event, use caution, the message published from this action could cause the event to trigger again.

This warning includes cases where the action publishes to a topic directly monitored by the action and cases where the action monitors a view and publishes to an underlying topic of the view. The warning also applies to configurations in which two or more actions "cross publish" to topics that are monitored by the other action. An example of the last case is an action that monitors TopicOne and publishes to TopicTwo, while another action monitors TopicTwo and publishes to TopicOne.

The result of a configuration like the ones described above is called a publish loop. AMPS does not support unterminated publish loops or loops that produce a large number of cycles before terminating.

To publish a message, this module requires a Topic, the MessageType to publish on and also the Data that the message will contain. In addition to that, this module also accepts optional parameters listed below:

Parameter

Description

Topic (required)

The topic of the message being published.

MessageType (required)

The message type for the topic.

There is no default for this parameter.

Data (required)

The data that the message will contain.

Delta

Whether to use a delta publish.

When this option is present, and the value is true, the action will use a delta publish.

UpdateOnly

Specifies whether a delta publish is allowed to insert a record, or only update a record.

When a delta publish is specified (that is, Delta is true ), and this option is set to true, AMPS will only accept the publish if there is a record present to be updated.

When no value is specified, this option is false.

This module does not add any variables to the AMPS context.

Manage Replication Acknowledgment

AMPS provides modules for downgrading replication destinations that fall behind and upgrading them again when they catch up.

Module Name

Does

amps-action-do-downgrade-replication

Downgrades replication connections from synchronous to asynchronous if the age of the last acknowledged message is older than a specified time period.

amps-action-do-upgrade-replication

Upgrades previously-downgraded replication connections from asynchronous to synchronous if the age of the last acknowledged message is more recent than a specified time period.

This action has no effect on replication destinations that are specified as async in the configuration file.

The modules determine when to downgrade and upgrade based on the age of the oldest message that a destination has not yet acknowledged. When using these modules, it is important that the thresholds for the modules are not set too close together, otherwise; AMPS may repeatedly upgrade and downgrade the connection when the destination is consistently acknowledging messages at a rate close to the threshold values. To avoid this, 60East recommends that the Age set for the upgrade module is 1/2 of the age used for the downgrade module.

The amps-action-do-downgrade-replication module accepts the following options:

Parameter

Description

Age (required)

Specifies the maximum message age at which AMPS downgrades a replication destination to async.

When this action runs, AMPS downgrades any destination for which the oldest unacknowledged message is older than the specified Age.

For example, when the Age is 5m, AMPS will downgrade any destination where a message older than 5 minutes has not been acknowledged.

There is no default for this parameter.

GracePeriod

The approximate time to wait after start up before beginning to check whether to downgrade links.

The GracePeriod allows time for other AMPS instances to start up and for connections to be established between AMPS instances.

The amps-action-do-upgrade-replication module only applies to destinations configured as sync that have been previously downgraded. The module accepts the following options:

Parameter

Description

Age (required)

Specifies the maximum message age at which a previously-downgraded destination will be upgraded to sync mode.

When this action runs, AMPS upgrades any destination that has been previously downgraded where the oldest unacknowledged message is more recent than the time value specified in the Age parameter.

For example, if a destination has been downgraded to async mode and the Age is 2m, AMPS will upgrade the destination when the oldest unacknowledged message to that destination is less than 2 minutes old.

There is no default for this parameter.

GracePeriod

The approximate time to wait after start up before beginning to check whether to upgrade links.

The GracePeriod allows time for other AMPS instances to start up, and for connections to be established between AMPS instances.

These modules do not add any variables to the AMPS context.

Extract Values from a Message

The amps-action-do-extract-values module extracts message values from a message and stores the values in a variable.

To extract values from a message, this module requires the MessageType and Value parameters. In addition to that, this module also accepts an optional parameter listed below:

Parameter

Description

MessageType (required)

The message type for the message to parse.

There is no default for this parameter.

Value (required)

An assignment statement that specifies the variable to store the extracted value in and the XPath identifier for the value to extract.

This action can contain any number of Value elements, each providing an assignment statement.

The format of the assignment is as follows:

 variable=amps-expression

For example, the following assignment statement stores the value of the /previousRegionCode within the message to the variable PREVIOUS_REGION. After this action runs, the content of the variable can be referenced in subsequent action steps as {{PREVIOUS_REGION}}.

 PREVIOUS_REGION=/previousRegionCode

Likewise, the following assignment statement creates a string from the values of the /firstName and /lastName fields within the message, and stores that to the variable COMBINED_NAME. After this action runs, the content of the variable can be referenced in subsequent action steps as {{COMBINED_NAME}}.

 COMBINED_NAME=CONCAT(/firstName, ' ', /lastName)

There is no default for this option. If no Value options are provided, AMPS does not save any values from the parsed message.

Data

Contains the data to parse. Typically it is a message received from a publish event or retrieved from a SOW query. The action will expand context variables in this parameter when it runs.

There is no default value for this parameter. If it is omitted, AMPS will not parse data when the action is run.

The module amps-action-do-extract-values adds the variables specified by the Value options to the current context.

Translate Data Within an Action

The amps-action-do-translate-data action allows you to translate the value from variables in the current context. One common use for this action is to translate a large number of status values into a smaller number of states before publishing that information in a message. For example, an order processing system may track a large number of finely-grained status codes, while the reporting view for customers may want to map those status codes to a smaller set of codes such as "pending", "shipped" and "delivered". This action allows you to easily translate those codes within AMPS.

When used to assemble a message, this action provides equivalent results to a set of nested conditional statements in a view projection. However, if you are using actions to parse, assemble and publish messages, this action gives you the ability to change values.

Parameter

Description

Data (required)

The data to translate. Most often, this is the value of a variable in the current context.

Value (required)

The variable to store the translated value in.

Case

A translation statement. The translation statement takes the form of original_value=translated_value.

This action allows you to provide any number of Case statements.

The action matches the Data provided to the original_value in each Case statement. When it finds a matching value, the action stores the translated value in the variable identified by the Value statement.

For example, the following translation statement translates a value of credit_check_in_progress to a value of pending.

 <Case>credit_check_in_progress=pending</Case>

There is no default for this option.

Default

The default translation. AMPS sets the value of the variable to the contents of this element if no Case statement matches the Data provided.

This element is optional. If no Default is specified, AMPS uses the value of the original Data as the default translation.

Increment Counter

The amps-action-do-increment-counter module allows AMPS to increment a counter by a value. Counters persist across action runs, and are saved in the instance memory until the instance is restarted.

If a counter with the specified name does not currently exist in the instance when the action runs, AMPS creates the counter with a value of 0 and then immediately increments it with the specified value. If the counter is already present, AMPS will simply increment the counter.

To see an example of amps-action-do-increment-counter, refer to the Action Configuration Examples section at the end of this chapter.

This module requires a Key that tells AMPS which counter to increment and a Value that tells AMPS where to store the incremented value.

Parameter

Description

Key (required)

The name of the counter that AMPS will increment.

There is no default value for this parameter.

Value (required)

The variable in which to store the current value of the counter.

This module adds a variable that contains the counter, as specified in the Value parameter, to the current context.

Raise a Custom Event

The AMPS action system provides a way to create custom events and run an action when the custom event is raised. A custom event is raised by the amps-action-do-execute-event action. Events are received by the amps-action-on-execute-event module.

This action requires one of the following parameters:

Parameter

Description

Event (required)

The name of the event to raise.

There is no default value for this parameter.

EventVariable (required)

The variable from which to retrieve the name of the event to raise.

There is no default value for this parameter.

This module does not add any variables to the AMPS context. However, the variables currently in the AMPS context will be received by any action that runs in response to this event.

Execute System Command

The amps-action-do-execute-system module allows AMPS to execute system commands.

The parameter for this module is simply the command. The command executes in the current working directory of the AMPS process, with the credentials and environment of the AMPS process.

The thread used to execute the command is monitored by AMPS thread monitoring. This means that the command must complete within a short period of time (on the order of a second or two at the longest) or AMPS may consider the thread to have become deadlocked.

Parameter

Description

Command

The command to execute.

When the action runs, this command is executed as a shell command on the system where AMPS is running.

This module does not add any variables to the AMPS context.

This module executes system commands with the credentials of the AMPS process. It is possible to damage the system, interrupt the AMPS service, or cause data loss by executing commands with this module. 60East recommends against using any data extracted from an AMPS message in the command executed.

Manage Queue Transfers

AMPS provides actions to enable and disable the "proxied transfer" setting for message queues. As described in the Failover and Queue Message Ownership section of the Replicating Messages Between Instances chapter of the AMPS User Guide, this setting allows an instance to manage ownership of a queue message that is owned by an instance that is offline (or otherwise unreachable from this instance). 60East recommends that these actions only be configured in situations where the administrative interface is unavailable. Unlike most other settings for which actions are provided, the "proxied transfer" setting is intended for disaster recovery rather than normal maintenance.

The amps-action-do-enable-proxied-transfer action can be used to enable proxied transfer for a queue. The amps-action-do-disable-proxied-transfer action can be used to disable proxied transfer for a queue.

Enabling proxied transfer will allow this instance to take ownership of messages owned by an unreachable instance, allowing those messages to be delivered. However, it also introduces the risk of duplicate delivery and duplicate processing in cases where the instance that currently owns the message is still online (but the replication network connection has failed), or in cases where the instance that currently owns the message becomes available again and begins servicing requests. See the Failover and Queue Message Ownership section for more details.

Although an action is provided for flexibility, 60East does not recommend that the enable_proxied_transfer setting is enabled automatically, due to the possibility of duplicate delivery. Instead, this action should be configured to run in response to action by an administrator, after the administrator determines that one of the instances that contains the queue is, in fact, offline and that the possibility of duplicate processing is an acceptable risk.

These actions are intended to assist in maintaining message delivery from a distributed queue during an outage of one of the instances that services the queue. When this setting is enabled, the possibility of duplicate delivery exists.

These actions require the following parameters:

Parameter

Description

Topic (required)

The name of the queue topic for which to enable or disable proxied transfer.

There is no default value for this parameter.

MessageType (required)

The message type of the topic for which to enable or disable proxied transfer.

There is no default value for this parameter.

This module does not add any variables to the AMPS context.

Create Minidump

AMPS provides a module for creating minidumps. The amps-action-do-minidump module provides a way for developers and/or administrators to easily create minidumps for diagnostic purposes.

Running this module does not cause AMPS to exit.

Module Name

Does

amps-action-do-minidump

Creates a minidump.

This module does not require any parameters.

This module does not add any variables to the AMPS context.

Shut Down AMPS

The amps-action-do-shutdown module shuts down AMPS. This module is registered as the default action for several Linux signals, as described in the section on starting actions on a Linux signal.

Causing this module to run is the recommended way to shut down AMPS. This is most often done by sending SIGINT to the AMPS process, which is handled by amps-action-on-signal to run this module.

Module Name

Does

amps-action-do-shutdown

Shuts down AMPS.

This module does not require any parameters.

This module does not add any variables to the AMPS context.

Debug Action Configuration

AMPS provides modules for debugging your AMPS action configuration.

Module Name

Does

amps-action-do-nothing

Takes no action.

Does not modify the state of AMPS in any way. The module simply logs that it was called.

amps-action-do-echo-message

Echoes the specified message to the log. The message appears in the log as message 29-0103, at info level.

The logging configuration must allow this message to be recorded for the output of this action to appear in the log.

The amps-action-do-nothing module requires no parameters.

The amps-action-do-echo-message module requires the following parameter:

Parameter

Description

Message

The message to echo. The default for this parameter is simply an empty string.

These modules do not add any variables to the AMPS context.