Configuration Guides
Install and configure agents, collectors and integrations per technology.
.NET
- Monitor .NET Error Transactions with Applicare and OpenTelemetry (Offline Mode)NOTE: Before starting the configuration, make sure that the system has .NET Framework 4.6.1 or higher. Use the command below to check. Lower versions …
- Monitor .NET Error Transactions with Applicare and OpenTelemetryStep 1: Open powershell in administrator mode and execute the following commands one by one.
- Monitoring Containerized .NET Applications with Applicare and OpenTelemetryTo enable OpenTelemetry auto-instrumentation for your .NET application and send traces to Applicare, you will need to apply configuration changes in b…
- Monitor .NET ApplicationCurrently, Applicare supports profiling only .NET applications hosted on IIS in Windows.
- Manually Installing the .NET Applicare AgentLog in to Applicare console, Navigate to Download Agents screen but selecting it on left hand side menu.
- Set up the .NET agent to run automatically using Task SchedulerStep 1: To initiate the .Net Agent with Task Scheduler. Navigate to the Agent's installation home directory, open a command window as an administrator…
- Monitor .NET applications running on Windows using OpentelemetryTo begin monitoring, Install the SingleAgent.
Java
- Applicare Java RequirementsWindows https://github.com/ojdkbuild/ojdkbuild/releases/download/java-1.8.0-openjdk-1.8.0.252-2.b09/java-1.8.0-openjdk-jre-1.8.0.252-2.b09.ojdkbuild.w…
- Install SingleAgent in the Java ApplicationStep 1: Install Applicare SingleAgent on the machine where Java application is running. Follow the installation instructions for Installing Applicare …
- Finding the Java Installation DirectoryFollow these steps to find Java Installation path.
- Restarting the SingleAgentNavigate to the ApplicareSingleAgent home directory.
- Customize Agent heap memory and jvm argumentsManaging JVM configurations manually is time-consuming, requiring remote server access and direct editing of configuration files. Applicare simplifies…
- Java Application Server Configuration SettingsChoose the server from the grid and then click the Configure Dynamic Instrumentation button.
- Include the server name and JVM arguments in the Gradle Jib build configuration.Open the Gradle build file and append the container block at the end of the Jib configuration section.
- Install Applicare agent in Java appa.) Add the following to your service's JVM options and replace the bold values with your specific settings if you're starting your server as a servic…
- Installing Applicare SingleAgent using WrapperStep 1: Log in to Applicare console, navigate to Download Agents screen and download SingleAgentWindows. Then, Copy the ApplicareSingleAgentWindows.zi…
- Install the Applicare agent using Wrapper on a Linux systemStep 1: Log in to Applicare console, navigate to Download Agents screen and download SingleAgentLinux. Copy ApplicareSingleAgentLinux.zip file to the …
Docker
- Install SingleAgent in a Docker ContainerStep 1, 2 and 3 are necessary only if the ApplicareSingleAgentLinux directory is not present on the Docker-installed machine.
- Install Applicare SingleAgent in Docker container using scriptEach time you build the Docker image, you will need to follow these manual steps.
- Install ApplicareSingleAgent in a Docker ContainerStep 2: Create a directory named ApplicareSingleAgent
- Deploy SingleAgent in a Docker ContainerStep 1: Add the following packages to include the apk command if the Docker container is running on Alpine OS.
- Agent configuration in docker containerNote: We can easily download our agent directly into the container, but some containers don't have commands like curl or wget and unzip, so we have to…
- Install Applicare SingleAgent in a Java Jar Application Docker ContainerTo install ApplicareSingleAgent in Java Jar application docker container, add the below script based on the OS after the "FROM" command to the dockerf…
- .NET in Docker Image# Use the official Windows Server Core image FROM mcr.microsoft.com/dotnet/aspnet:7.0-windowsservercore-ltsc2019 AS base LABEL author="Cerasela Consta…
- Applicare deployed in a Docker container with Derby databasePre Requisite: Make sure docker is installed before following the below steps.
- Install Applicare SingleAgent on UbuntuStep 1: Insert the following scripts after the "FROM" command in the Dockerfile.
- Install Applicare SingleAgent on Alpine LinuxStep 1: Add the following scripts immediately after the FROM command in the Dockerfile.
- Install Applicare SingleAgent on CentOSStep 1: Insert the following scripts immediately after the FROM command in the Dockerfile.
- Install Applicare SingleAgent in DebianOSStep 1: Insert the following scripts immediately after the FROM command in the Dockerfile.
- Install Applicare SingleAgent in a RedHat Enterprise Linux (RHEL) Docker ImageStep 1: Add the following scripts after the command in the Dockerfile.
- Configuring an agent within an Nginx container using a (docker-compose.yml) fileStep 1: Create a file called customnginx.conf with the content below.
- Agent configuration in Nginx containerIf the nginx.conf file is not on the local machine, copy the file from the nginx container and save it on the local machine.
- Deploy the agent in the Nginx-proxy containerNote: This step is only necessary when initially creating the container that deploys the agent. For subsequent operations, such as stopping and restar…
Kubernetes
- .NET monitoring in KubernetesBefore you begin .NET monitoring installation, ensure the Applicare Collector is already installed and actively running on your Applicare Controller m…
- Install OTel agent in Kubernetes clusterStep 1: Install the OTel log agent on the Kubernetes cluster. Download the yaml file and replace <ApplicareIp> on line 53 of the yaml file with the IP…
- Local Kubernetes MonitoringStep 1: Run kubectl top nodes in your Kubernetes environment. If you do not see the details as expected, proceed to Step 2 if the information is displ…
- Remote Kubernetes MonitoringCreate an applicare-setup.yml file with the below content:
- Installing Applicare SingleAgent in Kubernetes Containers Using a ScriptNote: Follow the steps in this to install the agent on the docker image.
- Kubernetes MonitoringGo to the Kubernetes menu in the left side menu, click the Cluster IP to view the details.
- Monitoring Nginx in a KubernetesStep 1: Add the following line next to the From line in the Dockerfile that builds Nginx.
- Deploy Go auto instrumentation in KubernetesStep 1: Create an autoinstrument.yaml file with the following content.
OpenTelemetry
- Applicare OTel Collector installation on LinuxApplicare OTel Collector is only supported on Redhat, Ubuntu and Debian OS.
- Applicare Metrics, Trace and Log Collector installation on WindowsStep 1: Download Applicare collector from the link below and extract it to the directory named applicareotelcollectorwindows in the Applicare home dir…
- Monitor Traces and Metrics in Containerized .NET Applications with Applicare and OpenTelemetryTo enable OpenTelemetry auto-instrumentation for your .NET application and send traces to Applicare, you will need to apply configuration changes in b…
Install, start & update
- Applicare Installation for LinuxEssential System Requirements for Applicare Controller and Database
- Run the Applicare Controller as a service on LinuxTo install or uninstall applicare.service, admin permissions are required.
- Starting Applicare Controller on a Linux systemMethod 1: Starting Controller via Command mode
- Applicare Installation for WindowsSystem Requirements for Applicare Controller and Database
- Update the Applicare ControllerStep 1: To download the update.jar, log in with your Arcturus Support Login ID on the Arcturus Support site.
- Applicare UpdatesTo check for available updates and download update files, visit the Applicare Updates page located in the Configuration section.
- Deploying the Applicare Service PackService packs (patches) are minor incremental updates or bug fixes that provide incremental improvements.
- Starting the Applicare ControllerMethod 1 - Start the Controller Using Command mode
- Applicare SentinelA new custom error handling mechanism within Sentinel. This feature is designed to replace the standard blank white error page with a branded, user-fr…
- Set up the Applicare Controller in Task SchedulerFollow the steps for installing ApplicareController
- Start the Controller in Task SchedulerStep 1: Open the command prompt with administrator privileges, and navigate to the Applicare controller installation directory, and run the createCont…
- Start the Controller in command-line modeStep 1: Open a command prompt with administrator privileges.
- Update AgentsYou can update or restart the active agent in the Applicare controller remotely, without needing physical access to machine running the agent; instead…
- Downloading Applicare AgentsNavigate to the machine where you plan to deploy SingleAgent and run the command provided below. Replace the ControllerProtocol, ControllerIP, Control…
- Installing the SingleAgent on WindowsLogin into Applicare console and navigate to the Download Agents screen.
- Manual Installation of Applicare SingleAgent on LinuxFor a quick installation of SingleAgent, use the CURL or WGET commands from the Download Agents page. If CURL or WGET is not available, follow the ins…
- Uninstalling an agent and scheduled task on WindowsStep 1: Open the Command Prompt in administrator mode, navigate to the ApplicareSingleAgentWindowsagentscripts directory, and execute the deleteAgentT…
- Remote Deployment for ApplicareProvide the configuration details for the machine where the agent will be deployed:
- Deploying the agent on Linux and Windows via the Remote Deployment featureStep 1: Log in to Applicare controller and navigate to the Remote Deployment screen on left side menu.
- Standalone Agent for BTC CollectorAdd the JVM argument -Dapplicare.btx.collector=true to the Standalone Agent startup configuration. To prevent the automatic addition of the collector …
- Applicare Agent's Impact on Application PerformanceThe Applicare agent imposes very minimal overhead on application performance, with the impact being mostly negligible and almost undetectable. By defa…
- Starting SingleAgent on LinuxTo enable background mode, Navigate to the directory where ApplicareSingleAgent/agentscripts and run following command.
- SingleAgent Installation Using Command Mode for LinuxLogin into Applicare console and navigate to Download Agents screen.
- Starting SingleAgent on WindowsWe can start SingleAgent using either of the following methods:
- Installing SingleAgent via Command Line on WindowsLogin in to Applicare console and navigate to the Download Agents screen.
- Deploying the agent on Windows using an Ansible scriptEnsure that Ansible is installed before proceeding with the steps below.
- SingleAgent Remote deployment in Windows using PowershellApplicare provides the capability to deploy agents remotely, ensuring a smooth and efficient setup process.
- Setting Up Automatic Start of Applicare Agent with Windows Task SchedulerTo Applicare SingleAgent start task is automatically added to Windows Task Scheduler when downloaded using the PowerShell command from the Agent Downl…
- Task creation to stop the SingleAgentNavigate to ApplicareSingleAgent home directory and create a stopAgent.bat file with the following content. Save the file once created.
Application servers
- Installing the Agent for Tomcat, JBoss, WebLogic, WebSphere, and Other Java-Based MonitoringLog in to Applicare console and navigate to the Download Agents screen.
- Domain ConfigurationYou need to save WebLogic domain information in Applicare before deploying the Applicare agent to WebLogic servers.
- WebSphere MonitoringInstall Applicare SingleAgent in the machine that WebSphere is running in. 2. Log in to the Websphere console and navigate servers> server Types > Web…
- Wildfly MonitoringStep 1: Install Applicare SingleAgent in the machine where Wildfly is running. Follow the instructions for installing Applicare SingleAgent
- Monitoring JBoss on LinuxStep 1: Install the Applicare SingleAgent on the machine running JBoss. Follow these steps: installing Applicare SingleAgent
- Installing SingleAgent for AppServer on LinuxLog in to Applicare console, and navigate to the Download Agents section.
- SingleAgent Installation for Appserver using command Mode for LinuxLog in to Applicare console, Navigate to Download Agents screen.
- Installing Applicare SingleAgent on WebLogic running on LinuxInstall Applicare SingleAgent in the machine where Weblogic is running. 2. Navigate to the <weblogicdomainpath>bin directory and add the following lin…
- Installing SingleAgent for Appserver on Windows using Command LineLog in to the Applicare console and navigate to the Download Agents screen.
- Deploying SingleAgent for WebLogic on WindowsInstall Applicare SingleAgent on the machine where Weblogic is running. - If Weblogic is started using startWebLogic.bat file follow these step. 2. Na…
Web servers
- Apache Monitoring on LinuxFollow the steps for Installing Applicare SingleAgent. 2. After starting the agent, it will automatically be registered with the Applicare controller.…
- Apache server 2.4 Monitoring for LinuxTo installing Applicare SingleAgent, Follow these steps:
- Apache server 2.4 Monitoring for windowsFollow the steps for installing Applicare SingleAgent
- Monitoring NginxStep 1: Follow the steps for Installing Applicare SingleAgent
- Start Nginx using Task SchedulerFollow the steps below to start Nginx using Task Scheduler.
- Monitoring Applications Hosted on IIS with ApplicareFollow the steps for Installing Applicare SingleAgent.
Databases
- SQL Server database setup and configurationCreate a new user with SQL server authentication and assign the following permissions for all the databases including the master database. 1. dbdatare…
- SingleAgent Database monitoringApplicare SingleAgent monitors MySQL, MS SQL Server, PostgreSQL, Oracle databases and MongoDB database
- MySQL Database Monitoring ConfigurationCreate a new user and grant them 'SELECT', 'SHOW DATABASES' and 'SHOW VIEW' permissions.
- Validate MySQL settings for monitoringEnsure that the following performance schemas are enabled in MySQL. If they are not, add the settings to the my.ini file (for windows) (Windows Path: …
- PostgreSQL Database ConfigurationCreate a new user and assign the LOGIN, SUPERUSER, INHERIT permissions.
- Validation of SQL Server DB Trace ConfigurationIf you do not see the database metrics on the Applicare dashboard, after the configuration of SQL server database monitoring, Please check the followi…
- Oracle Database Monitoring ConfigurationCreate a new user and provide the below two permissions.
- Verify PostgreSQL Server Configuration for Monitoringa) Permission: LOGIN, SUPERUSER, and INHERIT
- Automate Daily Backups of Settings Tables Records to an Archive DatabaseStep 1: Before backing up the database, create the applicarearchive schema, execute the applicare-related sql's and ensure all tables are created.
- Automate Daily Batch Backups of few Tables Records to an Archive DatabaseStep 1: Before backing up the database, create the applicarearchive schema, execute the applicare-related sql's and ensure all tables are created.
- Automate Daily Batch Backups of Init profiling hist Table Records to an Archive DatabaseStep 1: Before backing up the database, create the applicarearchive schema, execute the applicare-related sql's and ensure all tables are created.
- Applicare MySQL Database Backup (Windows)Step 1: Open command prompt in administrator mode on Windows machine. Navigate to the path bin directory where MySQL was installed.
- Set up the Applicare schema in MySQLOpen the command prompt as an administrator then navigate to MySQLinstalldirectory/bin path.
- MySQL 8 installer for windowsStep 1: Download the MySQL 8 on below link and install it.
- Installing MySQL on LinuxStep 1: Download and add the following MySQL Yum repository to install the latest version of MySQL.
- Configuring SQL Mode for MySQL in ApplicareOpen Services application and stop the MySQL service.
- MySQL Database MonitoringLogin to Applicare controller and navigate to the Server Analyzer menu to view the details.
- Increasing Memory for DerbyBy default, the Applicare Derby database is configured to run on a laptop and is suitable for testing with Applicare with One or two agents. If the De…
- Create a new user account and designate the relevant permissionsSubstitute <newuser> and <password> with the newly username and password you have just created.
- MSSQL manual Trace deletionStep 1: Login into MSSQL Server with 'sa' or Applicare user. The user should have sysadmin permission and create and modify permission for SQL traces …
- Monitoring for MSSQL Server Always On Availability GroupsApplicare SingleAgent is an effective tool for managing and monitoring your availability groups. It offers a comprehensive view of performance across …
- Monitoring for MS SQL Server databasesAccess the Applicare controller and navigate to the Server Analyzer menu to view the details.
- Creating a new user for SQL Server authentication and grant the necessary permissions.Grant the dbdatareader role to all the databases, including the master database. 2. Grant the following permissions: alter trace, view server state, v…
- Oracle Database MonitoringLog in to Applicare console and navigate to the Server Analyzer menu item on the left to view the details.
- PostgreSQL Database MonitoringLog in to Applicare controller and navigate to the Server Analyzer menu to view the details.
- MongoDB database monitoringCreate a new user with the root role for that new user.
- Redis MonitoringCreate a new user account and designate the relevant permissions in Redis.
Node.js, PHP, Go & COBOL
- Node.JS Monitoring for LinuxTo monitor Node.js Applications, You need to configure both Node.js and Single agent. Ensure that both are running on the same machine:
- Manual Instrumentation for Node.js (Docker image)Step 1: Download the tracing.js file to the root directory.
- Node.JS Monitoring for WindowsTo monitor Node.js Applications, You need to configure both Node.js and Single agent. Ensure that both are running on the same machine:
- PHP Application MonitoringLog in to Applicare controller and navigate to the Server Analyzer->Telemetry Traces menu to view the details of PHP application transaction.
- Configure PHP applicationTo automatically instrument a PHP application, use PHP latest version 8.2 or later is required.
- Manually instrument a Go application using OpenTelemetry and ApplicareThis installs the OpenTelemetry SDK components and net/http instrumentation.
- Automatically instrument a Go Application running in Docker with OpenTelemetry and Applicare (With additional container)A Go executable can be instrumented without modifying the original code of the application by configuring environment variables and running the instru…
- COBOL Monitoring with ApplicareCOBOL monitoring is especially important for maintaining the health, performance, and security of COBOL-based systems, which often serve as the backbo…
- COBOL MonitoringApplicare supports COBOL and other legacy technologies without requiring source code changes by using Shell Script Sensors and Remote Commands. Applic…
AWS
- AWS MonitoringLog in to the Applicare controller and navigate to the AWS screen in the left side menu. Select the configured IAM user.
- Configuring AWS MonitoringSteps 1: Log in to Applicare controller. On the left side menu, navigate to the AWS screen and click Connect New IAM User button located at the bottom…
- Creating a DB parameter Group for AWS RDS MySQLNavigate to RDS -> Parameter Groups and click the Create parameter group button.
Administration & security
- Configuring Applicare Server for HTTPS with Self Signed CertificateStep 1: Stop the Applicare controller. Create "sscertificate" folder in C drive.
- Configure HTTP Strict Transport Security (HSTS) in ApplicareHTTP Strict Transport Security (HSTS) is a web security policy mechanism, which helps protect web application users against some passive (eavesdroppin…
- Configuring Applicare with OKTA using SAMLLog in to your OKTA Admin account and select People from the Directory menu.
- Manage LDAP User RolesThis page guides how to configure LDAP user Roles.
- Active Directory/LDAP SettingsGo to Configuration -> LDAP Server Configuration to set up LDAP server settings and enable LDAP authentication.
- Role of Single Sign-On UsersApplicare provides granular access control to the resources it monitors. A user can be assigned either full control or read-only access to a specific …
- User Role ManagementApplicare allows fine grain access control to the resources that are monitored by Applicare. A user can be given either full control or readonly acces…
- Email/SMTP Configuration in ApplicareAn app password must be created before setting up mail in Applicare.
- Set Up SMTP for Yahoo MailStep 1: Log in to your Yahoo mail account.
- Configure SMTP for GmailStep 2: Click on your Google account icon and select Manage your Google Account.
- Disable Auto Add SNMP on controllerAdd the below jvm argument in the controller catalina.bat/sh file
- SQL injection detection in ApplicareSQL injection is a type of cyberattack where malicious SQL code is inserted into a web application's input fields, which then interferes with the appl…
- Vulnerability Scanner SetupThe scan will run on the configured server. 2. Once the scan is complete, the report will be transferred to the controller and saved in the controller…
- REST API Calls Using Token-Based AuthenticationTo access data via the REST API, generate a API token in Applicare and include it in your request.
- REST API Calls Using X.509 Certificate-Based AuthenticationX.509 Cert-based authentication provides an easy and secure way to access Applicare REST APIs. Below are the details on enabling it.
- Applicare Data SecurityApplicare can be deployed either as an On-Prem(ise) hosting or accessed through our SaaS environment.
- Manage Applicare DataAs the Applicare Controller operates, table storage in the database will grow, potentially reducing disk space on the machine running the controller. …
- Export/Import Applicare Configuration
- Remote CommandsRemote Commands allow you to execute scripts or processes on servers where Applicare agents are installed. They can be configured to run as specific u…
- Applicare InformationDisplay the information of the Applicare Controller and agent that has been added to the Applicare Controller and license details.
- Compressing log files on WindowsCreate a .bat file in the directory where the log folder is located.
- LAMA configuration in ApplicareLog in to Applicare console. Go to LAMA menu and click the settings icon.