LogoLogo
AMPS Server Documentation 5.3.5 (Early Access)
AMPS Server Documentation 5.3.5 (Early Access)
  • Welcome to AMPS
  • Introduction to AMPS
    • Overview of AMPS
    • Getting Started With AMPS
      • Installing AMPS
      • Starting AMPS
      • JSON Messages - A Quick Primer
      • spark: the AMPS command-line client
      • Evaluating AMPS on Windows or MacOS
      • Galvanometer and RESTful Statistics
    • AMPS Basics: Subscribe and Publish to Topics
    • State of the World (SOW): The Message Database
      • When Should I Store a Topic in the SOW?
      • How Does the SOW Work?
      • Configuration
      • Queries
      • Atomic Query and Subscribe
      • Advanced Messaging and the SOW
    • Record and Replay Messages with the AMPS Transaction Log
    • Message Queues
    • Scenario and Feature Reference
      • Recovery Strategies
    • Getting Support
    • Advanced Topics
    • Next Steps
  • AMPS Evaluation Guide
    • Introduction
    • Evaluation and Development with AMPS
    • Tips on Measuring Performance
    • Next Steps
  • AMPS User Guide
    • Introduction
      • Product Overview
      • Requirements
      • Organization of this Guide
        • Documentation Conventions
      • Technical Support
    • Installing and Starting AMPS
      • Installing AMPS
      • Starting AMPS
    • Configuring AMPS
      • Getting Started with AMPS Configuration
      • Units, Intervals, and Environment Variables
      • Working with Configuration Files
      • Including External Files
      • Production Configuration
      • Instance-Level Configuration
      • Configuration Options Quick Reference
    • Subscribe and Publish
      • Topics
      • Filtering Subscriptions by Content
      • Conflated Subscriptions
      • Replacing Subscriptions
      • Messages in AMPS
      • Message Ordering
      • Retrieving Part of a Message
    • AMPS Expressions
      • Syntax
      • Identifiers
      • AMPS Data Types
      • Grouping and Order of Evaluation
      • Logical Operators
      • Arithmetic Operators
      • Comparison Operators
      • LIKE Operator
      • Conditional Operators
      • Working with Arrays
      • Regular Expressions
      • Performance Considerations
    • AMPS Functions
      • AMPS Function Overview
      • String Comparison Functions
      • Concatenating Strings
      • Managing String Case
      • Replacing Text in Strings
      • Extracting Matching Text in Strings
      • String Manipulation Functions
      • Date and Time Functions
      • Array Reduce Functions
      • Geospatial Functions
      • Numeric Functions
      • CRC Functions
      • Message Functions
      • Client Functions
      • Coalesce Function
      • AMPS Information Functions
      • Typed Value Creation
      • Constructing Fields
      • Aggregate Functions
    • State of the World (SOW) Topics
      • How Does the SOW Work?
      • Using the State of the World
      • Understanding SOW Keys
      • Indexing SOW Topics
      • Programmatically Deleting Records from the Topic State
      • SOW Maintenance
        • Creating a Maintenance Schedule for a Topic
        • Setting Per-Message Lifetime
      • Storing Multiple Logical Topics in One Physical Topic
      • Configuring a SOW
        • Configuring Topics in a SOW
    • Querying the State of the World (SOW)
      • Overview of SOW Queries
      • Query and Subscribe
      • Historical SOW Topic Queries
      • Managing Result Sets
      • Batching Query Results
    • Out-of-Focus Messages (OOF)
    • State of the World Message Enrichment
    • Incremental Message Updates
      • Using Delta Publish
      • Understanding Delta Publish
      • Delta Publish Support
    • Receiving Only Updated Fields
      • Using Delta Subscribe
      • Identifying Changed Records
      • Conflated Subscriptions and Delta Subscribe
      • Select List and Delta Subscribe
      • Options for Delta Subscribe
    • Conflated Topics
      • Configuring Conflated Topics in a SOW
    • Aggregation and Analytics
      • Understanding Views
      • Defining Views and Aggregations
      • Constructing Field Contents
      • Best Practices for Views
      • View Examples
      • Aggregated Subscriptions
      • Configuring Views in a SOW
    • Record and Replay Messages
      • Using the Transaction Log and Bookmark Subscriptions
      • Understanding Message Persistence
      • Replaying Messages with Bookmark Subscription
      • Managing Journal Files
      • Using amps-grep to Search the Journal
      • Configuring a Transaction Log
    • Message Queues
      • Getting Started with AMPS Queues
      • Understanding AMPS Queuing
      • Advanced Messaging and Queues
      • Replacing Queue Subscriptions
      • Handling Unprocessed Messages
      • Queue Subscriptions Compared to Bookmark Replays
      • Configuring Queues in a SOW
      • Advanced Queue Configuration
    • Message Types
      • Default Message Types
      • BFlat Messages
      • MessagePack Messages
      • Composite Messages
      • Protobuf Message Types
      • Struct Message Types
      • Configuring Message Types
    • Command Acknowledgment
      • Requesting Acknowledgments
      • Receiving Acknowledgments
      • Bookmark Subscriptions and Completed Acknowledgments
      • Bookmark Subscriptions and Persisted Acknowledgments
      • Acknowledgment Conflation and Publish Acknowledgements
    • Transports
      • Client Connections
      • Replication Connections
      • Transport Filters
      • Configuring Transports
      • Configuring Protocols
    • Running AMPS as a Linux Service
      • Installing the Service
      • Configuring the Service
      • Managing the Service
      • Uninstalling the Service
    • Logging
      • Log Message Format
      • Message Levels
      • Message Categories
      • Logging to Files
      • Logging to Syslog
      • Looking up Errors with ampserr
      • Configuring Logging
    • Event Topics
      • Client Status Events
      • SOW Statistics Events
      • Persisting Event Topics
    • Utilities
      • Command-Line Basic Client
      • Dump clients.ack File
      • Dump journal File
      • Dump queues.ack File
      • Dump SOW File
      • Dump Journal Topic Index File
      • Find Bookmark or Transaction ID in Transaction Log
      • Find Information in Error Log or Transaction Log
      • Identify Type of AMPS File
      • List/Explain Error Codes
      • Query Statistics Database
      • Statistics Database Report
      • Storage Performance Testing
      • Submit Minidump to 60East
      • Obsolete Utility: Upgrade File Formats
    • Monitoring AMPS
      • Statistics Collection
        • Time Range Selection
        • Output Formatting
      • Galvanometer
      • Configuring Monitoring
    • Configuring AMPS for Automation with Actions
      • Choosing When an Action Runs
        • On a Schedule
        • On AMPS Startup or Shutdown
        • On a Linux Signal
        • On a REST Request
        • On Minidump Creation
        • On Client Connect or Disconnect
        • On Client Logon
        • On Client Offline Message Buffering
        • On Subscribe or Unsubscribe
        • On Incoming Replication Connections
        • On Outgoing Replication Connections
        • On Message Published to AMPS
        • On Message Delivered to Subscriber
        • On Message Affinity
        • On SOW Message Expiration
        • On SOW Message Delete
        • On OOF Message
        • On Message Condition Timeout
        • On Message State Change
        • On a Custom Event
      • Choosing What an Action Does
        • Rotate Error/Event Log
        • Compress Files
        • Truncate Statistics
        • Manage Transaction Log Journal Files
        • Remove Files
        • Delete SOW Messages
        • Compact SOW Topic
        • Query SOW Topic
        • Manage Security
        • Enable or Disable Transports
        • Publish Message
        • Manage Replication Acknowledgment
        • Extract Values from a Message
        • Translate Data Within an Action
        • Increment Counter
        • Raise a Custom Event
        • Execute System Command
        • Manage Queue Transfers
        • Create Minidump
        • Shut Down AMPS
        • Debug Action Configuration
      • Conditionally Stopping an Action
        • Based on File System Capacity
        • Based on an Expression
      • Examples of Action Configuration
        • Archive Journals Once a Week
        • Archive Journals On RESTful Command
        • Record Expired Queue Messages to a Dead Letter Topic
        • Copy Messages that Exceed a Timeout to a Different Topic
        • Deactivate and Reactivate Security on Signals
        • Reset Entitlements for a Disconnected Client
        • Extract Values from a Published Message
        • Shut Down AMPS When a Filesystem Is Full
        • Increment a Counter and Echo a Message
    • Replicating Messages Between Instances
      • Replication Basics
      • Replication Resynchronization
      • Replication Compression
      • Destination Server Failover
      • Two-Way Replication
      • PassThrough Replication
      • Guarantees on Ordering
      • Replication Security
      • Understanding Replication Message Routing
      • Replicated Queues
      • Replication Best Practices
      • Configuring Replication
        • Configuring Outgoing Replication Destinations
        • Configuring Incoming Replication Transports
        • Replication Configuration Validation
    • Highly Available AMPS Installations
      • Overview of High Availability
        • Example: Pair of Instances for Failover
        • Example: Regional Distribution
        • Example: Regional Distribution with HA
        • Example: Hub and Spoke / Expandable Mesh
      • Details of High Availability
      • Slow Client Management and Capacity Limits
      • Message Ordering Considerations
    • Operation and Deployment
      • Capacity Planning
      • Linux OS Settings
      • Upgrading AMPS
      • Using AMPS with a Proxy
      • Operations Best Practices
    • Securing AMPS
      • Authentication
        • Configuring Authentication
      • Entitlement
        • Configuring Entitlement
      • Providing an Identity for Outbound Connections
      • Protecting Data in Transit Using TLS/SSL
      • Loadable Authentication/Entitlements Modules
        • Simple Access Entitlements Module
        • RESTful Authentication and Entitlements
        • Multimethod Authentication Module
        • OAuth Authentication Module
      • Loadable Authenticator Modules
        • Multimethod Authenticator
        • Command Execution Authenticator
    • Troubleshooting AMPS
      • Planning for Troubleshooting
      • Diagnostic Utilities
      • Finding Information in the Log
      • Reading Replication Log Messages
      • Troubleshooting Disconnected Clients
      • Troubleshooting Regular Expression Subscriptions
    • AMPS Distribution Layout
    • Optionally-Loaded Modules
      • Loadable Function Modules
        • Legacy Messaging Functions
        • Special-Purpose Functions
      • Loadable Authentication/Entitlements Modules
      • Loadable Authenticator Modules
      • Loadable SOW Key Generator
        • Chaining Key Generator
      • Configuring Modules
    • AMPS Statistics
    • File Format Versions
  • AMPS Monitoring Guide
    • Statistics Types
    • Table Reference
    • Administrative Actions
    • Host Statistics
      • cpu (host statistics)
      • disks (host statistics)
      • memory (host statistics)
      • name (host statistics)
      • network (host statistics)
    • AMPS Instance Statistics
      • api (instance statistics)
      • clients (instance statistics)
      • config.xml (instance statistics)
      • config_path (instance statistics)
      • conflated_topics (instance statistics)
      • cpu (instance statistics)
      • cwd (instance statistics)
      • description (instance statistics)
      • environment (instance statistics)
      • lifetimes (instance statistics)
      • logging (instance statistics)
      • memory (instance statistics)
      • message_types (instance statistics)
      • name (instance statistics)
      • name_hash (instance statistics)
      • pid (instance statistics)
      • processors (instance statistics)
      • queues (instance statistics)
      • queries (instance statistics)
      • replication (instance statistics)
      • sow (instance statistics)
      • statistics (instance statistics)
      • subscriptions (instance statistics)
      • timestamp (instance statistics)
      • transaction_log (instance statistics)
      • transports (instance statistics)
      • tuning (instance statistics)
      • uptime (instance statistics)
      • user_id (instance statistics)
      • version (instance statistics)
      • views (instance statistics)
  • AMPS Command Reference
    • Commands to AMPS
      • logon command
      • Publishing
        • publish command
        • delta_publish command
      • Subscribing to and Querying Topics
        • subscribe command
        • sow command
        • sow_and_subscribe command
        • unsubscribe command
        • delta_subscribe command
        • sow_and_delta_subscribe command
      • Removing Messages (SOW/Topic or Message Queue)
      • heartbeat command
      • flush command
    • Responses from AMPS
      • sow: Content from Server
      • publish: Content from Server
      • oof: Content from Server
      • ack: Status from Server
      • group_begin / group_end: Result Set Delimiters
    • Protocol Reference
      • AMPS Protocol
      • Legacy Protocols Reference
    • Command Cookbook
      • Cookbook: Delta Publish
      • Cookbook: Delta Subscribe
      • Cookbook: Publish
      • Cookbook: SOW
      • Cookbook: SOW and Delta Subscribe
      • Cookbook: SOW and Subscribe
      • Cookbook: SOW Delete
      • Cookbook: Subscribe
  • Deployment Checklist
    • Ensure Sufficient Capacity
    • Apply System and AMPS Configuration
    • Create Maintenance Plan
    • Create Monitoring Strategy
    • Create Patch and Upgrade Plan
    • Create and Test Support Process
    • Conclusion
  • AMPS Clients
    • Performance Tips and Best Practices
    • C++
    • C#/.NET
    • Java
    • JavaScript
    • Python
  • Glossary
Powered by GitBook

Get Help

  • FAQ
  • Legacy Documentation
  • Support / Contact Us

Get AMPS

  • Evaluate
  • Develop

60East Resources

  • Website
  • Privacy Policy

Copyright 2013-2024 60East Technologies, Inc.

On this page
Export as PDF

Glossary

Term
Definition

Acknowledgment

A networking technique in which the receiver of a message is responsible for informing the sender that the message was received.

In AMPS:

  • Commands to the AMPS server from an application are asynchronous: AMPS responds with acknowledgment messages to indicate the results of the command.

  • An application acknowledges messages from an AMPS queue to indicate that the message has been fully processed, and AMPS can remove the message from the queue.

Authentication

The process of establishing a proven identity for a connection to AMPS.

Bookmark

Unique identifier for a message, formed from a combination of a number derived from the client name (which is used as the publisher session ID) and a sequence number managed by the client. Unlike a SOW Key (defined later), this identifier is unique to each individual message. That is, two updates to the same record have different bookmarks, even though they update the same key.

Conflated Topic

A copy of a SOW topic that conflates updates on a specified interval. This helps to conserve bandwidth and processing resources for subscribers to the conflated topic.

Conflation

The process of merging a group of messages into a single message. For example, when a particular record in the SOW is updated hundreds or thousands of times a second, conflation can enable an application to receive the most recent update every 300ms, reducing the network traffic to the application while still guaranteeing that the application has recent data.

Delta

A message that contains only the differences between the previous state of a stored message and the new state of the stored message. AMPS supports delta messaging for both publish (changing a subset of fields in a message) and subscribe (receiving only the fields of a message that have changed).

Entitlement

The process of assigning permissions to a connection based on the identity established for that connection.

Expression

A text string that produces a specific value. AMPS uses expressions in filters and when constructing fields for enrichment or projecting views.

Filter

A text string that is used to match a subset of messages from a larger set of messages. In AMPS, every filter is an AMPS expression that returns TRUE or FALSE.

Message Expiration

The process where the life span of records stored in a State-of-the-World topic or queue are limited.

Message Type

The data format used to encapsulate messages. Each message within AMPS has a single, defined message type. Each connection to AMPS uses a single, defined message type.

oof (out of focus)

Notification to a subscriber that a message which was previously a result of a SOW or a SOW subscribe filter result has either expired, been deleted from the SOW or has been updated such that it no longer matches the filter criteria.

Queue

A topic that provides competitive consumption with the goal of allowing an application to process a message once, regardless of the number of consumers. Notice that a queue is not necessary to provide reliable replay or consistent ordering -- the transaction log provides those properties.

Replication

The process of duplicating the messages stored into an AMPS instance to one or more additional AMPS instances. The instance that contains the messages pushes those messages to the instance that receives the messages over a transport designed for that purpose.

Replication Destination

An instance of AMPS that is receiving messages directly from another AMPS instance (the replication source).

Replication Source

An instance of AMPS which receives a message and then sends the message directly to one or more other AMPS instances (the replication destinations). The source is responsible for ensuring that the destination or destinations have received the messages.

Replication Transport

A transport used only for replication (amps-replication transport), that allows the flow of incoming replication messages from another AMPS instance (the replication source).

Slow Client

A client that is being sent messages at a rate which is faster than it can consume, to the point where AMPS detects that the network buffer to the client has filled.

SOW (State of the World) Topic

A last value cache used to store the current state of messages belonging to a topic.

SOW Key

A value used to identify a unique record in an AMPS SOW topic. For a given topic, you can configure AMPS to generate the SOW key based on content in the message, provide the SOW key on each message published, or use a SOW key generator module to programmatically create the SOW key. Within a SOW topic, publishes to the same SOW key value are interpreted updates to the same record.

Topic

A label, which is affixed to every message by a publisher, which is used to aggregate and group messages. Messages within a topic all have the same message type, persistence, and delivery paradigm.

Transaction Log

A history of all messages published for a configurable set of topics which can be used to recreate an up to date state of all messages processed. Applications can query and replay messages from the transaction log. The transaction log preserves the order in which messages are processed by an instance of AMPS both within a topic and across topics.

Transport

The network protocol used to to transfer messages between AMPS subscribers, publishers and other instances of AMPS (via replication).

View

An in-memory topic constructed by AMPS from the contents of one or more SOW topics. A view can aggregate or transform the underlying topics, and can be of a different message format than the underlying topics. As the contents of the SOW topic change, the view is updated to reflect the current contents of the underlying topic or topics.

PreviousPerformance Tips and Best Practices

Last updated 7 days ago