ManageEngine® Applications Manager


APM Insight .NET Agent

<< Prev

Home

Next >>

APM Insight .NET Agent

 

 

Applications Manager's .NET agent gives you insight into the way your .NET web-transactions work; helping you quickly drill-down to the root cause of issues. Now you can resolve performance degradation of .NET applications, no matter where they originate. Just download the latest .NET Agent and deploy it in your application server.

 

Click on the links below to learn more about the working of .NET agent and its usage:

 


 

Working of APM Insight .NET Agent

 

The .NET Agent, instrumented into the application using .NET profiling API, collects the data (Metric/traces) and sends it to the Agent service through the Inter Process Communication (IPC). The Agent service, in turn, receives the data from the .NET agent and sends it to Applications Manager through a scheduler.


Installing the Agent

Installation Requirements

Installation Instructions

Now the .NET agent is ready and all the ASP.NET applications running on the server will be monitored. The collected data should be available in the apm-insight tab of Applications Manager's web client within a few minutes.


Managing the agent

Starting the .NET Agent

Editing the .NET Agent Configuration

Stopping the .NET Agent

APM Insight Configuration

You can uninstall the agent from the Start menu. Click on Uninstall .NET Agent from the ManageEngine .NET Agent folder in the Start Menu to uninstall the agent.

 


Using Application Filters

You can choose individual application that you would want to monitor in your IIS server and view individual application metrics on your console. With this new feature you get the flexibility to add or remove monitoring of applications hosted under an IIS server.

 

Filtering Web Applications in settings dialog

 

For Agent Version 2.5 and above

Note: For agent version 2.3 to 2.5,

  • Stop the .NET Agent windows service before launching Edit Configuration window.

  • Start the .NET Agent after Saving your settings.

For Agents below Versions 2.3

 

1. Versions 2.0 to 2.3

2. Versions older than 2.0

 

 

Filtering Web Applications Manually

 

For Agent Version 2.3 and above

Changes to be made in Agent configuration

 

For Agents below Version 2.3

 

1. Versions 2.0 to 2.3

Changes to be made in Agent configuration

2. Versions older than 2.0

To filter Web Applications you must make configuration changes in the following:

Changes to be made in IIS Manager

Changes to be made in Agent configuration

In case of multimonitors, all sub folders in the above locations.


Transaction Grouping

Configuration Steps for .NET Agent:

Steps to perform transaction merge pattern configurations manually:

For Windows server 2003, the corresponding path will be in,

For 64-bit agent

%WINDIR%//ProgramData//DotnetAgent//

For Windows server 2003, the corresponding path will be in

%WINDIR%//Documents and Settings//All Users//Application Data//DotNetAgent//

For 32-bit agent

%WINDIR%//ProgramData//DotnetAgent//

For Windows server 2003, the corresponding path will be in

%WINDIR%//Documents and Settings//All Users//Application Data//DotNetAgent//

In case of multi-monitors, all sub folders for every application in the above locations.

We can add, remove or comment the patterns at any point of time in the configuration file.

Transaction Merge Pattern Samples

 

The below pattern will match with all transactions which start with aspsite/account/ and it will be renamed as account.

aspsite/account/*=account

The below pattern will match with all transactions which start with aspsite/ and end with /basicdetails. They will be renamed as basicdetails.

aspsite/*/basicdetails=basicdetails

The above pattern will match with all transactions which end with /educationdetails and it will be renamed as educationdetails.

*/educationdetails=educationdetails

 


Background Transactions

Applications Manager allows users the ability to monitor background processes and other jobs running within the web application.

 


Use .NET agent API for Custom Instrumentation

APM Insight .NET Agent API helps to track the user defined methods in a web application. It helps instrument specified methods in the web application DLLs for monitoring its performance. It can also be used to track specific parts of code.

Steps to Add the API

1. Add a reference to the library DotNetAgent.Api.dll to your web application project.

2. The API dll is available in the API Manager Tool installed location (C:\Program Files (x86)\APM Insight\APM Insight.NET Agent\AgentApi\DotNetAgent.Api.dll).

Note: For Agent below v2.3, locate the API dll from,(C:\Program Files\APM Insight\APM Insight .NET Agent (<x64 or x86>)\AgentApi\DotNetAgent.Api.dll).

 

3. The API contains a class named CustomTracker to track the performance of a method.

 

CustomTracker Class and its Methods

Constructors

CustomTracker(Type thisType)

eg: CustomTracker dotNetAgentCustomTracker = new CustomTracker(this.GetType());>

 

CustomTracker(Type thisType, string methodName)

eg: CustomTracker dotNetAgentCustomTracker = new CustomTracker(this.GetType(),"BasicDetails");

 

CustomTracker(Type thisType, string className, string methodName)

eg: CustomTracker dotNetAgentCustomTracker = new CustomTracker(this.GetType(), "EmpController", "BasicDetails");

 

CustomTracker.StartTracker (Type thisType, string className, string methodName)

CustomTracker.StopTracker()

4. Create an instance of CustomTracker class at the beginning of a method and invoke StopTracker() at the end of the method.

5. We can create CustomTracker instance with using{} block. The StopTracker() method will be called when disposing object automatically.

 

The following examples show the usage of this CustomTracker:


Example 1: Using the "using" statement:

 

public ActionResult BasicDetails(int id = 0)
{

AdminBL objadmin = new AdminBL();

using(CustomTracker customTracker = new CustomTracker(base.GetType(),"BasicDetails"))

{

    ASPSite.BL.MYSQLReference.BasicDetails basicDetails = objadmin.getBasicDetails(id);

      EmpApp.Models.BasicDetails basic = getBasicDetailsModel(basicDetails);

      return View(basic);

     }

}


Example 2: Using StartTracker and StopTracker within a try finally block:

 

public ActionResult BasicDetails(int id = 0)
{

    CustomTracker customTracker = null;

    AdminBL adminBL = new AdminBL();

    try

     {

        customTracker = new CustomTracker(base.GetType(),"BasicDetails");

        ASPSite.BL.MYSQLReference.BasicDetails basicDetails = adminBL.getBasicDetails(id);

        EmpApp.Models.BasicDetails basicDetailsModel = getBasicDetailsModel(basicDetails);

     }

    finally

    {

    customTracker.StopTracker();

    }

return View(basicDetailsModel);

}

Example 3: Using CustomTracker to Instrument part of a code.

 

public ActionResult BasicDetails(int id = 0)
{

      AdminBL adminBL = new AdminBL();

      using(CustomTracker customTracker = new CustomTracker(base.GetType(),"BasicDetails"))

    {

//Instrumenting part of a code. To check the time taken by the function FetchAllEmployees and the SQL calls made from this function.

using(CustomTracker fetchAllEmpTracker = new CustomTracker(base.GetType(),"FetchAllEmployees"))

          {

     FetchAllEmployees();

            }
ASPSite.BL.MYSQLReference.BasicDetails basicDetails = objadmin.getBasicDetails(id);

EmpApp.Models.BasicDetails basic = getBasicDetailsModel(basicDetails);
}

return View(basicDetailsModel);

 

Note:

  1. If the method name or class name is not given in the CustomTracker, it will attempt to get the current method name and class name by itself.
  2. The StartTracker() method will be called in constructor by default.
  3. If the agent not installed or the agent service stopped the invoked methods will have no effect.

 


Diagnostics tool

 

APM Insight .Net monitoring also features a diagnostics tool called HealthMonitor.exe. It monitors the health of the agent running in the server. The Health monitor is a self diagnostic tool, intended to provide a snapshot of the agent settings, for identifying and troubleshooting frequently encountered configuration issues in the agent. It is available, as a feature, from APM Insight .NET agent version 1.8 and above. It can be found in the start menu under "APM Insight .NET Agent" folder. Click the button on the left bottom corner of the tool to collects logs and creates a zip file for better troubleshooting and support.

 

Troubleshooting with APM Insight .NET Agent HealthMonitor

 

With the HealthMonitor, you can:

Note:


FAQ:

If you face problems during the installation or the .Net Agent, go to our .NET Agent FAQ page for troubleshooting tips.

<< Prev

Home

Next >>

APM Insight Ruby on Rails Agent

APM Insight Agent Configuration Options