Apica Docs
  • Welcome to Apica Docs!
  • PRODUCT OVERVIEW
    • Ascent Overview
    • Ascent User Interface
  • TECHNOLOGIES
    • Ascent with Kubernetes
      • Kubernetes is a Game-Changer
      • Ascent: Built on Kubernetes
    • Ascent with OpenTelemetry
      • Why Implement OpenTelemetry?
      • Common Use Cases for OpenTelemetry
      • How to Get Started with OpenTelemetry
      • Best Practices for OpenTelemetry Implementations
  • RELEASE NOTES
    • Release Notes
      • Ascent 2.10.4
      • Ascent 2.10.3
      • Ascent 2.10.2
      • Ascent 2.9.0
      • Ascent 2.8.1
      • Ascent 2.8.0
      • Ascent 2.7.0
      • Ascent 2.6.0
      • Ascent 2.5.0
      • Ascent 2.4.0
      • Ascent 2.3.0
      • Ascent 2.2.0
      • Ascent 2.1.0
        • Data Fabric
          • Releases-old
        • Synthetic Monitoring
        • Advanced Scripting Engine
        • IRONdb
      • Synthetic Monitoring
  • GETTING STARTED
    • Getting Started with Ascent
      • Getting Started with Metrics
      • Getting Started with Logs
        • OpenTelemetry
    • Ascent Deployment Overview
    • Quickstart with Docker-Compose
    • On-Premise PaaS deployment
      • On-Premise PaaS Deployment Architecture
      • Deploying Apica Ascent PaaS on Kubernetes
      • Deploying Apica Ascent PaaS on MicroK8s
      • Deploying Apica Ascent PaaS on AWS
      • Deploying Apica Ascent EKS on AWS using CloudFormation
      • Deploying Ascent on AWS EKS with Aurora PostgreSQL and ElastiCache Redis using Cloud Formation
        • Deploying Apica Ascent on AWS EKS with Aurora PostgreSQL and ElastiCache Redis using CloudFormation
        • Apica Ascent on AWS EKS (Private Endpoint) with Aurora PostgreSQL and ElastiCache Redis on prod VPC
      • Deploying Apica Ascent EKS on AWS using custom AMI
      • Deploying Apica Ascent EKS with AWS ALB
      • Deploying Apica Ascent PaaS in Azure Kubernetes Service
        • Azure Blob Storage Lifecycle Management
      • Deploying Apica Ascent with OpenShift
    • Boomi RTO Quick Start Guide
      • RTO Dashboarding
      • Alerting on RTO Metrics
      • Alerting on RTO Logs
    • Dashboards & Visualizations
  • DATA SOURCES
    • Data Source Overview
    • API
      • JSON Data source
      • RSS
    • AWS
      • Amazon Athena
      • Amazon CloudWatch ( YAML )
      • Amazon Elasticsearch Service
      • Amazon Redshift
      • MySQL Server (Amazon RDS)
    • NoSQL Data Sources
      • MongoDB
    • OLAP
      • Data Bricks
      • Druid
      • Snowflake
    • SQL Data Sources
      • PostgreSQL
      • Microsoft SQL Server
      • MySQL Server
    • Time Series Databases
      • Prometheus Compatible
      • Elasticsearch
      • InfluxDB
    • Ascent Synthetics
      • Checks
    • Ascent Logs
      • Logs
  • INTEGRATIONS
    • Integrations Overview
      • Generating a secure ingest token
      • Data Ingest Ports
    • List of Integrations
      • Apache Beam
        • Export Metrics to Prometheus
          • Pull Mechanism via Push-Gateway
        • Export Events to Apica Ascent
      • Apica ASM
      • Apica Ascent Observability Data Collector Agent
      • AWS
        • AWS CloudWatch
        • AWS ECS
          • Forwarding AWS ECS logs to Apica Ascent using AWS FireLens
          • ECS prometheus metrics to Apica Ascent
        • AWS S3
      • Azure
        • Azure Databricks
        • Azure Eventhub
        • Azure Event Hubs
      • Docker Compose
      • Docker Swarm logging
      • Docker Syslog log driver
      • F5 Big-Ip System
      • Filebeat
      • Fluent Bit
        • Forwarding Amazon-Linux logs to Apica Ascent using Fluent Bit
        • Fluent Bit installation on Ubuntu
        • Enabling IoT(MQTT) Input (PAAS)
        • IIS Logs on Windows
      • Fluentd
      • FortiNet Firewalls
      • GCP PubSub
      • GCP Cloud Logging
      • IBM QRadar
      • ilert
      • Incident Management
        • Webhooks
      • Jaeger
      • Kafka
      • Kinesis
      • Kubernetes
      • Logstash
      • MQTT
      • Network Packets
      • OpenTelemetry
      • Object store (S3 Compatible)
      • Oracle OCI Infrastructure Audit/Logs
      • Oracle Data Integrator (ODI)
      • OSSEC Variants (OSSEC/WAZUH/ATOMIC)
        • Apica Ascent-OSSEC Agent for Windows
      • Palo Alto Firewall
      • Prometheus
        • Spring Boot
        • Prometheus on Windows
        • Prometheus Remote Write
        • MongoDB Exporter
        • JMX Exporter
      • Rsyslogd
      • Syslog
      • Syslog-ng
      • Splunk Universal Forwarder
      • Splunk Heavy Forwarder
      • SNMP
      • Splunk Forwarding Proxy
      • Vault
        • Audit Vault Logs - AWS
        • Audit Vault Logs - OCI
        • Audit Vault Metrics
    • Apica API DOCS
  • DATA MANAGEMENT
    • Data Management Overview
    • Data Explorer Overview
      • Query Builder
      • Widget
      • Alerts
      • JSON Import
      • Creating Json Schema
        • Visualization
          • Line chart
          • Bar chart
          • Area chart
          • Scatter chart
          • Status chart
          • Counter chart
          • Stat chart
          • Size chart
          • Dense Status chart
          • Honeycomb chart
          • Gauge chart
          • Pie chart
          • Disk chart
          • Table chart
          • Date time chart
      • Time-Series AI/ML
        • Anomaly Detection
        • Averaging
        • Standard Deviation(STD)
      • Data Explorer Dashboard
        • Create a Dashboard
        • Editing Dashboard
          • Dashboard level filters
    • Timestamp handling
      • Timestamp bookmark
    • Large log/events/metrics/traces
  • OBSERVE
    • Monitoring Overview
      • Connecting Prometheus
      • Connecting Amazon Managed Service for Prometheus
      • Windows Redis Monitoring
      • Writing queries
        • Query Snippets
      • Query API
      • Use Apica API to ingest JSON data
    • Distributed Tracing
      • Traces
      • Spans
      • Native support for OTEL Traces
      • Windows .NET Application Tracing
      • Linux+Java Application Tracing
    • Log Management
      • Terminology
      • Explore Logs
      • Topology
      • Apica Ascent Search Cheat Sheet
      • Share Search Results
      • Severity Metrics
      • Log2Metrics
      • Native support for OTEL Logs
      • Reports
        • Accessing Reports results via API
      • Role-Based Access Control (RBAC)
      • Configuring RBAC
    • AI and LLM Observability
      • AI Agent Deployment
      • Ascent AI Agent Monitoring
      • Ascent Quick Start Guide
    • Synthetic Check Monitoring
      • Map View
      • List View
      • Alerting for Check Results
  • Flow
    • Overview
    • Pipeline Management
      • Configuring Pipelines
      • Visualize Pipelines
      • Pipeline Overview Dashboard
      • Forwarding Data
    • OpenTelemetry Ingest
      • OpenTelemetry Logs / Traces
      • OpenTelemetry Metrics
        • Transforming Metrics through Code Rules
    • Vault
      • Certificates
      • Variables
      • Lookups
    • Rules
      • FILTER
      • EXTRACT
      • SIEM and TAG
      • REWRITE
      • CODE
      • FORWARD
        • Rename Attributes
      • STREAM
    • Functions
      • ascent.encode
      • ascent.decode
      • ascent.persist
      • Ascent.variables
      • ascent.crypto
      • Ascent.mask
      • Ascent.net
      • Ascent.text
      • Ascent.time
      • Ascent.lookups
    • List of Forwarders
    • OpenTelemetry Forwarding
      • Metrics
      • Traces
      • Logs
    • Splunk Forwarding
      • Apica UF Proxy App Extension
        • Standalone Instance
        • List of Indexer Instances
        • Indexer Discovery
      • Splunk HTTP Event Collector (HEC) Forwarder
        • Metric Indexes
        • Non Metric Indexes
      • Splunk Syslog Forwarding
    • Real-Time Stream Forwarding
      • AWS Kinesis
      • Azure Eventhub
      • Google Pub/Sub
    • Security Monitor Forwarding
      • Arc Sight
      • RSA New Witness
    • Forwarding to Monitoring Tools
      • Datadog Forwarding
      • New Relic Forwarding
      • Dynatrace Forwarding
      • Elasticsearch Forwarding
      • Coralogix Forwarding
      • Azure Log Analytics Forwarding
    • Object Store Forwarding
      • S3 Compatible
      • Azure Blob Storage
    • Forwarding to Data Warehouse
      • GCP Bigquery
  • Customized Forwarders
    • JS Code Forwarding
  • LAKE
    • Powered by Instastore™
  • FLEET MANAGEMENT
    • Overview
    • Agents
    • Configurations
    • Packages
    • Fleet Repository Management
    • Advanced Search
    • List of Agents
      • Datadog Agent
      • Fluent-bit Agent
      • Grafana Alloy
      • OpenTelemetry Collector
      • OpenTelemetry Kubernetes
      • Prometheus Agent
  • COMMAND LINE INTERFACE
    • apicactl Documentation
  • AUTONOMOUS INSIGHTS
    • Time Series AI-ML
      • Anomaly Detection
      • Averaging
      • Standard Deviation(STD)
      • Forecasting
      • AI-ML on PromQL Query Data Set
      • Statistical Data Description
    • Pattern-Signature (PS)
      • Log PS Explained
        • Unstructured Logs
        • Semi-structured JSON
        • Reduce Logs Based on PS
        • Log PS Use Cases
          • Log Outlier Isolation
          • Log Trending Analysis
          • Simple Log Compare
      • Config PS
        • Config JSON PS
    • ALIVE Log Visualization
      • ALIVE Pattern Signature Summary
      • ALIVE Log Compare
    • Log Explained using Generative AI
      • Configuring Generative AI Access
      • GenAI Example Using Log Explain
    • Alerts
    • Alerts (Simple/Anomaly)
    • Alerts On Logs
    • Rule Packs
    • AI-powered Search
  • PLATFORM DOCS
    • Synthetic Monitoring Overview
      • Getting Started with ASM
        • Achieving 3 Clicks to Issue Resolution via ASM
        • FAQ - Frequently Asked Questions
        • Creating A New Check
          • Creating a New Real Browser Check
      • Explore the Platform
        • API Details
        • Check Types
          • Android Check
          • Command Check
          • Compound Check
          • Browser Check
          • Desktop Application Check
          • AWS Lambda Check
          • DNS Resolver Check
          • DNS Security Check
          • Domain Availability Check
          • Domain Delegation Check
          • Domain Expiration Date Check
          • Hostname Integrity Check
          • iPad Check
          • iPhone Check
          • Ping Check
          • Port Check
          • Postman Check
          • Response Time Check
          • SSL Certificate Expiration Check
          • Scripted Check
        • Dashboards
        • Integrations
          • DynaTrace Integration
          • Google Analytics Integration
          • Akamai Integration
          • Centrify Integration
          • AppDynamics Integration
          • PagerDuty Integration
          • ServiceNow Integration
          • Splunk Integration
        • Metrics
          • Analyze Site
          • Result Values
          • Trends
          • Analyze Metrics
        • Monitoring
          • Integrating ASM Metrics into Grafana Using Apica Panels
            • Understanding the ASM Imported Dashboards
            • Using the Apica Panels Dashboards
          • Understanding ASM Check Host Locations
        • Navigation
          • Manage Menu
        • Reports
        • Use Cases
      • Configurations
        • Configuring Checks
          • Understanding Check Results
            • Understanding ZebraTester Check Results
            • Understanding Browser Check Results
            • Understanding Check Details
          • Editing Checks
            • Editing Browser Checks
            • Editing ZebraTester Checks
          • Using Regular Expressions Within the ASM Platform
          • Understanding the Edit Scenario Page
          • Comparing Selenium IDE Scripts to ASM Scenarios
          • Configuring Apica DNS Check Types
          • Implementing Tags Effectively Within ASM
          • Storing and Retrieving Information Using the ASM Dictionary
        • Configuring Users
          • Configuring SSO Within ASM
        • Configuring Alerts
          • Configuring Webhook Alerts
      • How-To Articles
        • ASM Monitoring Best Practices
        • API Monitoring Guide
        • IT Monitoring Guide
        • Monitor Mission-Critical Applications through the Eyes of Your Users
        • How To Mask Sensitive Data in ASM
        • How to Mask Sensitive Data When Using Postman Checks
        • How to Handle URL Errors in a Check
        • How To Set Up SSO Using Azure AD
        • How to Set Up SSO Using Centrify
        • ASM Scenarios How-To
          • How To Pace a Selenium Script
          • How to Utilize XPath Within a Selenium Script
          • How to Mask Sensitive Information Within an ASM Scenario
          • Handling Elements Which Do Not Appear Consistently
          • How to Handle HTML Windows in ASM Scenarios
    • ZebraTester Scripting
      • ZebraTester Overview
      • Install ZebraTester
        • Download ZebraTester
          • Core ZebraTester V7.5-A Documentation
          • Core ZebraTester V7.0-B Documentation
          • Core ZebraTester V7.0-A Documentation
          • Core ZebraTester V5.5-Z Documentation
          • Core ZebraTester V5.5-F Documentation
        • Download the ZebraTester Recorder Extension
        • Windows Installation
          • ZebraTester on Windows
          • Generate Private CA Root Certificate
          • Windows System Tuning
          • Install a new ZT version on Windows Server
          • Install/Uninstall ZT Windows Installer Silently
        • macOS Installation
          • macOS Preinstallation Instructions
          • Generate Private CA Root Cert (macOS X)
          • System Tuning (macOS)
          • Import a CA Root Certificate to an iOS device
          • Memory Configuration Guidelines for ZebraTester Agents
      • ZebraTester User Guide
        • Menu and Navigation Overview
        • 1. Get a Load Test Session
          • Recording Web Surfing Sessions with ZebraTester
            • Further Hints for Recording Web Surfing Sessions
            • Recording Extension
              • Record Web Session
              • Cookies and Cache
              • Proxy
              • Page Breaks
              • Recording Extension Introduction
              • Troubleshooting
            • Add URL to ZebraTester
            • Page Scanner
          • Next Steps after Recording a Web Surfing Session
        • 2. Scripting the Load Test Session
          • 1. Assertions - HTTP Response Verificaton
          • 2. Correlation - Dynamic Session Parameters
            • 2b. Configuring Variable Rules
            • 2a. Var Finder
          • 3. Parameterization: Input Fields, ADR and Input Files
            • ADR
          • 4. Execution Control - Inner Loops
          • 5. Execution Control - URL Loops
          • 6. Execution Control -User-Defined Transactions And Page Breaks
          • 7. Custom Scripting - Inline Scripts
          • 8. Custom Scripting - Load Test Plug-ins
            • ZebraTester Plug-in Handbooks
          • Modular Scripting Support
        • 3. Recording Session Replay
        • 4. Execute the Load Test
          • Executing a First Load Test
          • Executing Load Test Programs
            • Project Navigator
              • Configuration of the Project Navigator Main Directory
            • Real-Time Load Test Actions
            • Real-Time Error Analysis
            • Acquiring the Load Test Result
            • More Tips for Executing Load Tests
          • Distributed Load Tests
            • Exec Agents
            • Exec Agent Clusters
          • Multiple Client IP Addresses
            • Sending Email And Alerts
            • Using Multiple Client IP Addresses per Load-Releasing System
        • 5. Analyzing Results
          • Detail Results
          • Load Test Result Detail-Statistics and Diagrams
          • Enhanced HTTP Status Codes
          • Error Snapshots
          • Load Curve Diagrams
          • URL Exec Step
          • Comparison Diagrams
            • Analysis Load Test Response Time Comparison
            • Performance Overview
            • Session Failures
        • Programmatic Access to Measured Data
          • Extracting Error Snapshots
          • Extracting Performance Data
        • Web Tools
        • Advanced Topics
          • Execute a JMeter Test Plan in ZebraTester
          • Credentials Manager for ZebraTester
          • Wildcard Edition
          • Execution Plan in ZebraTester
          • Log rotation settings for ZebraTester Processes
          • Modify Session
          • Modular Scripting Support
          • Understanding Pacing
          • Integrating ZebraTester with GIT
            • GitHub Integration Manual V5.4.1
      • ZebraTester FAQ
      • ZebraTester How-to articles
        • How to Combine Multiple ZebraTester Scripts Into One
        • Inline Scripting
        • How to Configure a ZebraTester Script to Fetch Credentials from CyberArk
        • How to Configure a ZebraTester Scenario to Fetch Credentials from CyberArk
        • How to Convert a HAR file into a ZebraTester Script
        • How to Convert a LoadRunner Script to ZebraTester
        • How to Import the ZT Root Certificate to an iOS device
        • How to iterate over JSON objects in ZebraTester using Inline Scripts
        • How to round a number to a certain number of decimal points within a ZebraTester Inline Script
        • How to Use a Custom DNS Host File Within a ZebraTester Script
        • How to Move a ZebraTester Script to an Older Format
        • API Plugin Version
        • Setting up the Memu Player for ZebraTester Recording
        • Inline Script Version
      • Apica Data Repository (ADR) aka Apica Table Server
        • ADR related inline functions available in ZT
        • Apica Data Repository Release Notes
        • REST Endpoint Examples
        • Accessing the ADR with Inline Scripts
      • ZebraTester Plugin Repository
      • Apica YAML
        • Installing and Using the ApicaYAML CLI Tool
        • Understanding ApicaYAML Scripting and Syntax
    • Load Testing Overview
      • Getting Started with ALT
      • Creating / Running a Single Load Test
      • Running Multiple Tests Concurrently
      • Understanding Loadtest Results
    • Test Data Orchestrator (TDO)
      • Technical Guides
        • Hardware / Environment Requirements
        • IP Forwarding Instructions (Linux)
        • Self-Signed Certificate
        • Windows Server Install
        • Linux Server Install
        • User Maintenance
        • LDAP Setup
        • MongoDB Community Server Setup
        • TDX Installation Guide
      • User Documentation
        • End User Guide for TDO
          • Connecting to Orson
          • Coverage Sets and Business Rules
          • Data Assembly
          • Downloading Data
        • User Guide for TDX
          • Connecting to TDX
          • Setting up a Data Profile
          • Extracting Data
          • Analyzing Data Patterns
          • Performing Table Updates
        • API Guide
          • API Structure and Usage
          • Determining Attribute APIs
            • Create Determining Attribute (Range-based)
            • Create Determining Attribute (Value-based)
            • Update Determining Attributes
            • Get Determining Attribute Details
            • Delete a Determining Attribute
          • Coverage Set API’s
            • Create Coverage Set
            • Update Coverage Set
            • Get All Coverage Set Details
            • Get Single Coverage Set Details
            • Lock Coverage Set
            • Unlock Coverage Set
            • Delete Coverage Set
          • Business Rule API’s
            • Create Business Rule
            • Update Business Rule
            • Get Business Rule Details
            • Get All Business Rules
            • Delete Business Rule
          • Workset API's
            • Create Workset
            • Update Workset
            • Get All Worksets
            • Get Workset Details
            • Unlock Workset
            • Clone Workset
            • Delete Workset
          • Data Assembly API's
            • Assemble Data
            • Check Assembly Process
          • Data Movement API's
            • Ingest (Upload) Data Files
            • Download Data Files
              • HTML Download
              • CSV Download
              • Comma Delimited with Sequence Numbers Download
              • Pipe Delimited Download
              • Tab Delimited with Sequence Numbers Download
              • EDI X12 834 Download
              • SQL Lite db Download
              • Alight File Format Download
          • Reporting API's
            • Session Events
            • Rules Events
            • Coverage Events
            • Retrieve Data Block Contents
            • Data Assembly Summary
        • Workflow Guide
        • TDO Project Builder User Guide
          • Project Design
          • Projects
            • Select Existing Project
            • Create a New Project
        • Format Function Guide
      • Release Notes
        • Build 1.0.2.0-20250213-1458
  • IRONdb
    • Getting Started
      • Installation
      • Configuration
      • Cluster Sizing
      • Command Line Options
      • ZFS Guide
    • Administration
      • Activity Tracking
      • Compacting Numeric Rollups
      • Migrating To A New Cluster
      • Monitoring
      • Operations
      • Rebuilding IRONdb Nodes
      • Resizing Clusters
    • API
      • API Specs
      • Data Deletion
      • Data Retrieval
      • Data Submission
      • Rebalance
      • State and Topology
    • Integrations
      • Graphite
      • Prometheus
      • OpenTSDB
    • Tools
      • Grafana Data Source
      • Graphite Plugin
      • IRONdb Relay
      • IRONdb Relay Release Notes
    • Metric Names and Tags
    • Release Notes
    • Archived Release Notes
  • Administration
    • E-Mail Configuration
    • Single Sign-On with SAML
    • Port Management
    • Audit Trail
      • Events Trail
      • Alerts Trail
Powered by GitBook
On this page
  • Overview
  • Dashboard
  • Apica Panels
  • Tools
  • Impersonate
  • Start Impersonation
  • Drop Impersonation
  • Maintenance
  • Maintenance Tasks
  • Apply Action
  • Selector View
  • Create A Maintenance Task
  • Table
  • Journal
  • Selectors
  • Entries
  • Traceroute
  • Introduction
  • Configuration
  • Traceroute Results
  • Messages
  • Create Message
  • Filter Checks
  • Filter Checks By Status
  • Log In
  • Remember Me
  • Reset Password
  • Apica Password and Login Policy
  • Password Requirements
  • Password Expiration
  • Inactive Logins
  • New Integration +
  • New Integration Configuration
  • New Integration Creation Wizard
  • Create Wizard: Step 1 Information
  • Create Wizard: Step 2 Specifics
  • Create Wizard: Step 3 Options
  • Step 4: Confirmation
  • Status Filter
  • Filter Checks

Was this helpful?

Edit on GitHub
Export as PDF
  1. PLATFORM DOCS
  2. Synthetic Monitoring Overview
  3. Explore the Platform

Navigation

The navigation bar is an important aspect of the ASM platform. It allows users to easily find all of the features offered within ASM. This article provides an overview of the different pages which can be accessed from the top navigation bar.

Clicking on the ASM image to the left of the Overview menu item will always bring you back to the main Dashboard.

Overview

Dashboard

See Dashboards for more information.

Apica Panels

The “Apica Panels” menu item allows users to view their configured Apica Panels instances. Apica Panels is a feature which allows users to integrate Apica data into Grafana dashboards for easier viewing; see Using the Apica Panels Dashboards for a complete overview of the feature. The “Apica Panels” menu item contains two sub-items: “Panels” and “About”.

Panels

Clicking the “Panels” link will bring you to the Panels page, on which you can see a high level overview of your Panels dashboards and open or delete an individual Panels dashboard.

The default Panels version available in the ASM SaaS portal is called “Apica Panels (v2)”. There are two major versions of Apica Panels; one version is based on Grafana version 4, and the other (Panels v2) is based on Grafana version 8. Apica Panels (v1) is only available to customers who had ASM Panels enabled before the major version change and have a need to maintain their older dashboards.

If you do not see “Apica Panels (v1)” on your dashboard, it means you do not have legacy Apica Panels configured on your account. Proceed with using only Panels v2 panels.

About (Apica Panels)

Clicking on the “About” sub-menu item will bring you to the “About” page, which provides a high-level overview of the Apica Panels feature.

Tools

The Tools section provides access to a number of different system features, such as Impersonate, API settings, Maintenance, Journal, Trace Route, and Messages.

Menu

Impersonate

With the Impersonate tool you can view Synthetic Monitoring from a different user's perspective. This feature can be very useful for troubleshooting or assisting your users with any problem they may encounter.

Item

Description

Filter

Search for user accounts by name.

Customer

Customer the user account belongs to.

User Name

Account user name.

Roles

List of roles associated with the account.

Last Activity

Clear the settings.

Switch from current user and impersonate.

Start Impersonation

The Impersonate tool allows Admin users to use Synthetic Monitoring with the permissions and settings of another user.

Impersonate User

To impersonate a user:

  • Open the Tools menu

  • Click Impersonate

  • Use the Filter to search for users

  • Find the user in the table

  • Click Impersonate

Drop Impersonation

When you want to stop impersonating, you can drop the impersonation without logging out and in again.

Drop Impersonation

To stop impersonating a user:

  • Open the User menu

  • Click Drop Impersonation

The user context is switched back to the original one.

Maintenance

The Maintenance view lets you modify or delete result records for individual checks and recalculate any associated consolidation records. The table shows a list of previous maintenance tasks and information about them:

Button

Description

Show entries

Number of rows to display per page.

Refresh History

Reload and update the table display.

Column

Description

Created

Timestamp for when the task was created.

Action

Action(s) performed by the task.

Status

The task status (running/success/cancelled).

Records

Number of items affected by the task.

Maintenance Tasks

Maintenance tasks can be created by selecting relevant checks and applying the appropriate action.

Apply Action

The apply action section lets you select what action to apply to the selected checks and queue the task for processing.

Option

Description

Update

Change the Check Result Status to this severity.

Set Value to NULL

Exclude the check from all calculations.

Delete

Remove the results.

Press Process Selected Records to remove the results.

Selector View

The selectors allow you to pick which checks to include in the task.

Item

Description

Type

List of check types.

Checks

List of checks of the selected type.

From

Start date and time for the period.

To

End date and time for the period.

Refresh

Reload and update the table display according to settings.

Display records

The number of rows to display per page.

Search

Search for checks by message text.

Create A Maintenance Task

Maintenance tasks can be created by selecting relevant checks and applying the appropriate action.

To create a maintenance task:

  1. Select the check results you want to modify:

  2. Type from the list

  3. Check from the list

  4. Pick a period:

  5. Enter a From date and time

  6. Enter a To date and time

  7. Search for strings in message texts, if needed

  8. Click Refresh

  9. Click Process Selected Records

A database task is placed in a queue for execution. It will run as soon as possible.

When queued, the maintenance task is visible in the Task table.

Table

The table shows the result of applying the selectors.

NOTE: The action in the task will apply to all selected checks. Make sure you have selected the correct checks before clicking the button.

Column

Description

Severity

Check result status severity.

Time

Timestamp for the check run.

Value

Duration

Message

The result message. (Clicking this will show the browser results).

Attempts

Number of attempts for the check run.

Journal

The Journal keeps a record of all user actions taken in the system.

Selectors

The journal can be filtered by a number of parameters.

Item

Description

Severity

From

Start date and time for the period.

To

End date and time for the period.

Message

Event description.

Customer

Customer account.

User

Involved user, if any.

IP-Address

The associated IP address for the event, if any.

Source

Originating location.

Category

Check

Involved check, if any.

Apply Filter

Reload and update the table display according to settings.

Entries

The Entries table shows the result of applying the selectors.

Column

Description

Severity

Timestamp

Date and time when the event occurred.

Message

Event description.

Customer

Customer account.

User

Involved user, if any.

IP-Address

The associated IP address for the event, if any.

Source

Originating location.

Category

Check

Involved check, if any.

Traceroute

Introduction

Configuration

The Traceroute tool configuration is fairly simple.

Item

Description

Host

Target destination.

Location

Execute

Perform traceroute.

These Tracroute settings are used by default and are not configurable:

Option

Value

Maximum number of hops

30

Wait timeout per hop

5 seconds

Job execution timeout

60 seconds

Traceroute Results

The results of the traceroute run is shown in the results frame.

The first line shows information about the traceroute configuration:

Hostname and IP address, the upper limit on hops to try, and size of the test packets.

On each subsequent row, information about each hop is shown:

Hop Number, hostname and/or IP address for the hop, and ther response times for each of the three test packets.

Messages

The Messages view lets you configure system messages to display to Synthetic Monitoring users.

View

Item

Description

Importance

Message importance (and display color).

Message

Message to display

Customer

Customer to display the message to.

Include Sub-customers

Also display message to sub-customers.

Active Time Period

Period during which to display the message.

Activity

Turn message on or off.

Configuration

Item

Description

Message

Message to display

Message is From

Sender to display

Active Time Period

Period during which to display the message.

Importance

Message importance (and display color).

Enabled

Turn message on or off.

Customer

Customer to display the message to.

Include Sub-customers

Also display message to sub-customers.

Test

Preview the message.

Cancel

Close dialog.

Save

Save the message.

Formatting

The message can contain some formatting. You format the text by putting the text within .

Formatting

Tag

Preview

Link:

[link="linkurl"]Link Text[/link]

Bold:

[b]Bold Text[/b]

Bold Text

Italic:

[i]Italic Text[/i]

Italic Text

Bold and Italic:

[ib]Italic and Bold Text[/ib]

*Italic and Bold Text*

Create Message

Messages can be added from the Messages view.

Add New Message

  • Click the Add New Message button

The Add New Messages dialog is shown

Configuration

Item

Description

Message

Message to display

Message is From

Sender to display

Active Time Period

Period during which to display the message.

Importance

Message importance (and display color).

Enabled

Turn message on or off.

Customer

Customer to display the message to.

Include Sub-customers

Also display message to sub-customers.

Test

Preview the message.

Cancel

Close dialog.

Save

Save the message.

Formatting

The message can contain some formatting. You format the text by putting the text within .

Formatting

Tag

Preview

Link:

link="linkurl"Link Text[/link]

Bold:

[b]Bold Text[/b]

Bold Text

Italic:

[i]Italic Text[/i]

Italic Text

Bold and Italic:

*Italic and Bold Text*

Filter Checks

All checks in all monitor groups can be filtered by using the filter buttons.

Filter Checks By Status

To filter out all checks with a particular status:

  • Click the color button in the menu bar for each status type you want to view

The button is highlighted, and only checks matching the status are shown in the dashboard.

  • Click the same color(s) again to disable the filter

Log In

Synthetic Monitoring is accessed through a web-based control panel, using basic authentication.

How to log in

To log in to Synthetic Monitoring:

  • Obtain your user and password from your system administrator

The login dialog is displayed:

  • Enter your username and password

  • Click Log In

When you have been logged in, the Overview Dashboard will be displayed.

The first time you log in (before creating checks), this view may be mostly empty.

Remember Me

You can have the browser remember your credentials, so you won't have to type them each time you log in.

##

To cache your username and password in the browser:

  • Click the Remember Me checkbox

Reset Password

In case you forget your password, you can reset it from the login dialog.

##

To reset the password:

  • Click the Forgot Your Password link

A dialog opens:

  • Enter your User Name

  • Click Continue

An email is sent to the address registered for your account.

Apica Password and Login Policy

Apica Synthetic Monitoring Portal logins will enforce the following minimum password requirements, in line with Apica security policy password and account security.

Password Requirements

  • Passwords will have a minimum length of 12 alphanumeric characters and must contain a mix of lower, upper, number, and special characters.

  • A User will be Locked out after 5 failed login attempts and will need to be unlocked by a user with a user or customer administrator role.

  • Users may reset their passwords as needed. Apica will provide a reset link via email. That emailed link will be valid for 1-hour.


The features below are Opt-In and need to be activated in coordination with Apica Support.

Password Expiration

  • After 90 days, a password will expire and need to be changed.

    • Warnings will be sent to the user email 7 days before and on the day of password expiration to allow the password to be reset before it expires.

  • Reset an expired password via the login page or contacting a User or Customer-level administrator.

Inactive Logins

  • After 90 days of user inactivity, Apica will consider the user account inactive and will deactivate that account.

    • Warnings will be sent to the user email 7 days before expiration and on the expiration day.

  • User or Customer level Administrators can activate a deactivated account to allow the user to log in again.

New Integration +

New integration checks are created from the New Integration + menu.

Menu

  • Click New Integration +

  • Select a Check type to create by clicking on the icon.

The New Integration wizard is shown.

New Integration Configuration

Configuration

After the New Integration wizard has been completed, the finished check is opened in edit mode.

##

In the edit view, you can set further configuration options for the check.

The exact options available vary with integration type.

New Integration Creation Wizard

All integration check types can be created through the New Integration wizard. The details vary with integration type, but the general principles are the same for all of them.

Create Wizard: Step 1 Information

In the first step, you can name the check and add a description.

##

Create Wizard: Step 2 Specifics

In the second step, you provide

  • integration information,

  • metric settings,

  • Locations - Introduction, and

  • other integration-specific settings.

##

Create Wizard: Step 3 Options

Step 3: Options

In the third step you can configure

  • how often the check is to run,

  • set threshold values for check notifications, and

##

Step 4: Confirmation

The final step shows all configurations made, and allows you to go back to revise the check or move forward and create it.

##

Status Filter

To the right of the navigation bar, there is a color coded status summary of all the checks associated with your user account.

Menu

The numbers in the colored boxes indicate the number of checks with that status.

Check Status is represented by four colors:

Color

Description

Green

Information

Yellow

Warning

Orange

Error

Red

Fatal

The colors are used in any context where the check status is displayed.

Filter Checks

All checks in all monitor groups can be filtered by using the filter buttons.

Filter Checks By Status

To filter out all checks with a particular status:

  • Click the color button in the menu bar for each status type you want to view

The button is highlighted, and only checks matching the status are shown in the dashboard.

  • Click the same color(s) again to disable the filter

PreviousUnderstanding ASM Check Host LocationsNextManage Menu

Was this helpful?

Check result to include.

Event to include.

.

Event .

.

The Traceroute tool allows you to easily run a Traceroute from any of our Apica to any URL or IP address you choose.

The purpose of running a traceroute is to get an indication of which way traffic takes between a source and a destination. Traceroute sends test Packet with TTL values starting at 1. The resulting Time Exceeded messages are used to discover any devices (called "hops") forwarding the packets to the destination. For each hop, the response time is recorded to indicate transmission speed. Any detected failures or packet losses on the way are also the recorder and displayed to give an idea of the transmission quality.

Apica to use as starting point.

[ib]Italic and Bold Text

Open the in your browser:

For more information, contact .

add it to one or more .

Locations
ICMP
Apica Synthetic Portal
support@apica.io
Monitor Groups
Colors
Colors
Severity
Event Categories
Severity
Event Categories
Link Text
Locations Locations
Link Text
/ib