Application Insights

最新推荐文章于 2024-06-18 09:39:28 发布

福海鑫森

最新推荐文章于 2024-06-18 09:39:28 发布

阅读量2.4k

点赞数 1

文章标签： ApplicationInsights

Application Insights 是为 Web 开发人员提供的可扩展分析服务，可帮助你了解实时应用程序的性能和使用情况。使用它可以检测和诊断性能问题与异常，以及编写代码来跟踪用户对应用执行的操作。

开源JAVA：https://github.com/Microsoft/ApplicationInsights-Java

开源PHP：https://github.com/Microsoft/ApplicationInsights-PHP

开源Rubby:https://github.com/Microsoft/ApplicationInsights-Ruby

Microsoft Azure:https://docs.microsoft.com/zh-cn/azure/application-insights/app-insights-java-get-started

概述示例数据的屏幕截图

Application Insights 支持 Linux、Unix 或 Windows 上运行的 Java 应用。

需要：

JRE 版本 1.7 或 1.8
Microsoft Azure 订阅。

如果有活动的 Web 应用，可以遵循替代过程在运行时将 SDK 添加到 Web 服务器。这种替代方法可以避免重新生成代码，但没有任何选项可以编写代码来跟踪用户活动。

如果你更喜欢 Spring 框架，请尝试配置 Spring Boot 初始值设定程序以使用 Application Insights 指南

1.获取 Application Insights 检测密钥

登录到 Microsoft Azure 门户。
创建 Application Insights 资源。将应用程序类型设置为 Java Web 应用程序。
查找新资源的检测密钥。稍后需要将此密钥粘贴到代码项目中。

2.将用于 Java 的 Application Insights SDK 添加到项目

为项目选择适当的方式。

如果使用 Maven...

如果项目已设置为使用 Maven 进行生成，请将以下代码合并到 pom.xml 文件。

然后刷新项目依赖项，以下载库。

XML复制


    <repositories>
       <repository>
          <id>central</id>
          <name>Central</name>
          <url>http://repo1.maven.org/maven2</url>
       </repository>
    </repositories>

    <dependencies>
      <dependency>
        <groupId>com.microsoft.azure</groupId>
        <artifactId>applicationinsights-web</artifactId>
        <!-- or applicationinsights-core for bare API -->
        <version>[2.0,)</version>
      </dependency>
    </dependencies>

发生了生成或校验和验证错误？ 尝试使用特定版本，例如：<version>2.0.n</version>。可以在 SDK release notes（SDK 发行说明）或 Maven artifacts（Maven 项目）中找到最新版本。
需要更新到新 SDK？ 请刷新项目的依赖项。

如果使用 Gradle...

如果项目已设置为使用 Gradle 进行生成，请将以下代码合并到 build.gradle 文件。

然后刷新项目依赖项，以下载库。

gradle复制


    repositories {
      mavenCentral()
    }

    dependencies {
      compile group: 'com.microsoft.azure', name: 'applicationinsights-web', version: '2.+'
      // or applicationinsights-core for bare API
    }

如果使用 Eclipse 创建动态 Web 项目...

使用用于 Java 的 Application Insights SDK 插件。注意：虽然使用此插件可以通过 Application Insights 更快地完成启动和运行操作（假定未使用 Maven/Gradle），但它不是一个依赖项管理系统。因此，更新此插件不会自动更新项目中的 Application Insights 库。

发生了生成或校验和验证错误？ 尝试使用特定版本，例如：version:'2.0.n'。可以在 SDK release notes（SDK 发行说明）或 Maven artifacts（Maven 项目）中找到最新版本。
若要更新到新的 SDK，请刷新项目的依赖项。

否则，如果是手动管理依赖项...

请下载最新版本，将所需文件复制到项目中，替换以前的版本。

问题...

-core 与 -web 组件之间有怎样的关系？
- applicationinsights-core 提供单纯的 API。始终需要此组件。
- applicationinsights-web 提供用于跟踪 HTTP 请求计数和响应时间的指标。如果不想要自动收集此遥测数据，可以忽略此组件。例如，如果想要编写自己的组件。
应怎样将 SDK 更新到最新版本？
- 如果使用 Gradle 或 Maven...
  - 请更新生成文件，对最新版本进行指定，或者使用 Gradle/Maven 的通配符语法，以便自动包括最新的版本。然后，请刷新项目的依赖项。在上面的 Gradle 或 Maven 的示例中，可以看到通配符语法。
- 如果是手动管理依赖项...
  - 下载最新的用于 Java 的 Application Insights SDK 并替换旧版本。 SDK release notes（SDK 发行说明）中描述了更改。

3.添加 ApplicationInsights.xml 文件

在项目中的 resources 文件夹中添加 ApplicationInsights.xml，或确保将其添加到项目的部署类路径。将以下 XML 复制到其中。

替换为从 Azure 门户获取的检测密钥。

XML复制


    <?xml version="1.0" encoding="utf-8"?>
    <ApplicationInsights xmlns="http://schemas.microsoft.com/ApplicationInsights/2013/Settings" schemaVersion="2014-05-30">


      <!-- The key from the portal: -->
      <InstrumentationKey>** Your instrumentation key **</InstrumentationKey>


      <!-- HTTP request component (not required for bare API) -->
      <TelemetryModules>
        <Add type="com.microsoft.applicationinsights.web.extensibility.modules.WebRequestTrackingTelemetryModule"/>
        <Add type="com.microsoft.applicationinsights.web.extensibility.modules.WebSessionTrackingTelemetryModule"/>
        <Add type="com.microsoft.applicationinsights.web.extensibility.modules.WebUserTrackingTelemetryModule"/>
      </TelemetryModules>

      <!-- Events correlation (not required for bare API) -->
      <!-- These initializers add context data to each event -->

      <TelemetryInitializers>
        <Add type="com.microsoft.applicationinsights.web.extensibility.initializers.WebOperationIdTelemetryInitializer"/>
        <Add type="com.microsoft.applicationinsights.web.extensibility.initializers.WebOperationNameTelemetryInitializer"/>
        <Add type="com.microsoft.applicationinsights.web.extensibility.initializers.WebSessionTelemetryInitializer"/>
        <Add type="com.microsoft.applicationinsights.web.extensibility.initializers.WebUserTelemetryInitializer"/>
        <Add type="com.microsoft.applicationinsights.web.extensibility.initializers.WebUserAgentTelemetryInitializer"/>

      </TelemetryInitializers>
    </ApplicationInsights>

也可将配置文件置于可以通过应用程序进行访问的任何位置。系统属性 -Dapplicationinsights.configurationDirectory 指定 ApplicationInsights.xml 所在的目录。例如，位于 E:\myconfigs\appinsights\ApplicationInsights.xml 的配置文件可以通过属性 -Dapplicationinsights.configurationDirectory="E:\myconfigs\appinsights" 进行配置。

检测密钥随遥测的每个项一起发送，并告知 Application Insights 在资源中显示它。
HTTP 请求组件是可选的。它自动将请求和响应时间的遥测数据发送到门户。
事件关联是对 HTTP 请求组件的补充。它将标识符分配到服务器收到的每个请求，并将此标识符添加为遥测的每个项的“Operation.Id”属性。使用它可以通过在诊断搜索中设置筛选器，来关联与每个请求关联的遥测。

设置检测密钥的替代方法

Application Insights SDK 按以下顺序查找密钥：

系统属性：-DAPPLICATION_INSIGHTS_IKEY=your_ikey
环境变量：APPLICATION_INSIGHTS_IKEY
配置文件：ApplicationInsights.xml

也可以在代码中设置方法：

Java复制

    TelemetryConfiguration.getActive().setInstrumentationKey(iKey);

4.添加 HTTP 筛选器

最后一个配置步骤可让 HTTP 请求组件记录每个 Web 请求。（如果只需要单纯的 API，则不需要执行此步骤。）

Spring Boot 应用程序

在 Configuration 类中注册 Application Insights WebRequestTrackingFilter：

Java复制

package <yourpackagename>.configurations;

import javax.servlet.Filter;

import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.core.Ordered;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import com.microsoft.applicationinsights.TelemetryConfiguration;
import com.microsoft.applicationinsights.web.internal.WebRequestTrackingFilter;

@Configuration
public class AppInsightsConfig {

    @Bean
    public String telemetryConfig() {
        String telemetryKey = System.getenv("<instrumentation key>");
        if (telemetryKey != null) {
            TelemetryConfiguration.getActive().setInstrumentationKey(telemetryKey);
        }
        return telemetryKey;
    }

    /**
     * Programmatically registers a FilterRegistrationBean to register WebRequestTrackingFilter
     * @param webRequestTrackingFilter
     * @return Bean of type {@link FilterRegistrationBean}
     */
    @Bean
    public FilterRegistrationBean webRequestTrackingFilterRegistrationBean(WebRequestTrackingFilter webRequestTrackingFilter) {
        FilterRegistrationBean registration = new FilterRegistrationBean();
        registration.setFilter(webRequestTrackingFilter);
        registration.addUrlPatterns("/*");
        registration.setOrder(Ordered.HIGHEST_PRECEDENCE + 10);
        return registration;
    }


    /**
     * Creates bean of type WebRequestTrackingFilter for request tracking
     * @param applicationName Name of the application to bind filter to
     * @return {@link Bean} of type {@link WebRequestTrackingFilter}
     */
    @Bean
    @ConditionalOnMissingBean

    public WebRequestTrackingFilter webRequestTrackingFilter(@Value("${spring.application.name:application}") String applicationName) {
        return new WebRequestTrackingFilter(applicationName);
    }


}

备注

如果使用的是 Spring Boot 1.3.8 或更旧版本，请将 FilterRegistrationBean 替换为下面的行

Java复制

    import org.springframework.boot.context.embedded.FilterRegistrationBean;

此类会将 WebRequestTrackingFilter 配置为 http 筛选器链上的第一个筛选器。它还会从操作系统环境变量中拉取检测密钥（如果可用）。

我们使用 Web http 筛选器配置而不是 Spring MVC 配置，因为这是一个 Spring Boot 应用程序，有其自己的 Spring MVC 配置。如需特定于 Spring MVC 的配置，请参阅以下部分。

使用 Web.xml 的应用程序

在项目中找到并打开 web.xml 文件，然后将以下代码合并到 Web 应用节点下，即应用程序筛选器的配置位置。

为获得最准确的结果，应该在其他所有筛选器的前面映射该筛选器。

XML复制


    <filter>
      <filter-name>ApplicationInsightsWebFilter</filter-name>
      <filter-class>
        com.microsoft.applicationinsights.web.internal.WebRequestTrackingFilter
      </filter-class>
    </filter>
    <filter-mapping>
       <filter-name>ApplicationInsightsWebFilter</filter-name>
       <url-pattern>/*</url-pattern>
    </filter-mapping>

   <!-- This listener handles shutting down the TelemetryClient when an application/servlet is undeployed. -->
    <listener>
      <listener-class>com.microsoft.applicationinsights.web.internal.ApplicationInsightsServletContextListener</listener-class>
    </listener>

如果使用 Spring Web MVC 3.1 或更高版本

编辑 *-servlet.xml 中的以下元素以包含 Application Insights 包：

XML复制


    <context:component-scan base-package=" com.springapp.mvc, com.microsoft.applicationinsights.web.spring"/>

    <mvc:interceptors>
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <bean class="com.microsoft.applicationinsights.web.spring.RequestNameHandlerInterceptorAdapter" />
        </mvc:interceptor>
    </mvc:interceptors>

如果使用 Struts 2

将此项添加到 Struts 配置文件（通常名为 struts.xml 或 struts-default.xml）：

XML复制


     <interceptors>
       <interceptor name="ApplicationInsightsRequestNameInterceptor" class="com.microsoft.applicationinsights.web.struts.RequestNameInterceptor" />
     </interceptors>
     <default-interceptor-ref name="ApplicationInsightsRequestNameInterceptor" />

如果默认堆栈中定义了拦截器，可以将拦截器添加到该堆栈。

5.运行应用程序

在开发计算机上以调试模式运行应用程序，或将其发布到服务器。

6.在 Application Insights 中查看遥测数据

返回 Microsoft Azure 门户中的 Application Insights 资源。

“概述”边栏选项卡中显示了 HTTP 请求数据。（如果未显示，请稍候片刻，并单击“刷新”。）

示例数据

了解有关指标的详细信息。

单击任一图表可查看详细聚合指标。

Application Insights 假设 MVC 应用程序的 HTTP 请求的格式为： VERB controller/action。例如，将 GET Home/Product/f9anuh81、GET Home/Product/2dffwrf5 和 GET Home/Product/sdf96vws 分组到 GET Home/Product 中。这种分组可提供有意义的请求聚合，例如请求数量和请求的平均执行时间。

实例数据

单击特定的请求类型可查看各个实例。

Application Insights 中显示两种类型的数据：聚合数据（存储并显示为平均值、计数和总和）；以及实例数据（HTTP 请求、异常、页面视图或自定义事件的不同报告）。

查看请求的属性时，可以查看与它关联的遥测事件，例如请求和异常。

分析：功能强大的查询语言

随着累积的数据越来越多，可以运行查询来聚合数据以及查找单个实例。分析是一个强大的工具，既可用于了解性能和使用情况，也可用于诊断。

分析示例

7.在服务器上安装应用

现在，将应用程序发布到服务器供用户使用，然后查看门户上显示的遥测数据。

请确保防火墙允许应用程序将遥测数据发送到以下端口：
- dc.services.visualstudio.com:443
- f5.services.visualstudio.com:443
如果必须通过防火墙路由传出流量，需定义系统属性 http.proxyHost 和 http.proxyPort。
在 Windows 服务器上，安装：
- Microsoft Visual C++ Redistributable
  
  （此组件启用性能计数器。）

异常和请求失败

自动收集未经处理的异常：

打开“设置”、“失败”

若要收集其他异常数据，可使用两个选项：

在代码中插入 trackException() 调用。
在服务器上安装 Java 代理。指定要监视的方法。

监视方法调用和外部依赖项

安装 Java 代理，记录指定的内部方法、通过 JDBC 发出的调用以及计时数据。

性能计数器

打开“设置”、“服务器”，查看一系列性能计数器。

自定义性能计数器收集

要禁用收集性能计数器的标准集，请将以下代码添加到 ApplicationInsights.xml 文件的根节点下：

XML复制

    <PerformanceCounters>
       <UseBuiltIn>False</UseBuiltIn>
    </PerformanceCounters>

收集其他性能计数器

可以指定要收集的其他性能计数器。

JMX 计数器（由 Java 虚拟机公开）

XML复制

    <PerformanceCounters>
      <Jmx>
        <Add objectName="java.lang:type=ClassLoading" attribute="TotalLoadedClassCount" displayName="Loaded Class Count"/>
        <Add objectName="java.lang:type=Memory" attribute="HeapMemoryUsage.used" displayName="Heap Memory Usage-used" type="composite"/>
      </Jmx>
    </PerformanceCounters>

displayName – Application Insights 门户中显示的名称。
objectName – JMX 对象名称。
attribute – 提取的 JMX 对象名称属性
type （可选）- JMX 对象的属性类型：
- 默认值：简单类型，例如 int 或 long。
- composite：性能计数器数据采用“Attribute.Data”格式
- tabular：性能计数器数据采用表行格式

Windows 性能计数器

每个 Windows 性能计数器是类别的成员（就好比字段是类的成员）。类别可以是全局的，也可以是带编号的实例或命名实例。

XML复制

    <PerformanceCounters>
      <Windows>
        <Add displayName="Process User Time" categoryName="Process" counterName="%User Time" instanceName="__SELF__" />
        <Add displayName="Bytes Printed per Second" categoryName="Print Queue" counterName="Bytes Printed/sec" instanceName="Fax" />
      </Windows>
    </PerformanceCounters>

displayName – Application Insights 门户中显示的名称。
categoryName – 与此性能计数器关联的性能计数器类别（性能对象）。
counterName – 性能计数器的名称。
instanceName – 性能计数器类别实例的名称，如果类别包含单个实例，则为空字符串 ("")。如果 categoryName 为 Process，而要收集的性能计数器来自应用运行所在的当前 JVM 进程，请指定 "__SELF__"。

性能计数器在指标资源管理器中以自定义指标的形式显示。

Unix 性能计数器

使用 Application Insights 插件安装 collectd ，获取各种不同的系统和网络数据。

本地转发器

本地转发器是从各种 SDK 和框架中收集 Application Insights 或 OpenCensus 遥测并将其路由到 Application Insights 的代理。它能够在 Windows 和 Linux 下运行。

XML复制

<Channel type="com.microsoft.applicationinsights.channel.concrete.localforwarder.LocalForwarderTelemetryChannel">
<DeveloperMode>false</DeveloperMode>
<EndpointAddress><!-- put the hostname:port of your LocalForwarder instance here --></EndpointAddress>
<!-- The properties below are optional. The values shown are the defaults for each property -->
<FlushIntervalInSeconds>5</FlushIntervalInSeconds><!-- must be between [1, 500]. values outside the bound will be rounded to nearest bound -->
<MaxTelemetryBufferCapacity>500</MaxTelemetryBufferCapacity><!-- units=number of telemetry items; must be between [1, 1000] -->
</Channel>

如果使用的是 SpringBoot 入门版，请将以下内容添加到配置文件（application.properties）中：

yml复制

azure.application-insights.channel.local-forwarder.endpoint-address=<!--put the hostname:port of your LocalForwarder instance here-->
azure.application-insights.channel.local-forwarder.flush-interval-in-seconds=<!--optional-->
azure.application-insights.channel.local-forwarder.max-telemetry-buffer-capacity=<!--optional-->

SpringBoot application.properties 和 applicationinsights.xml 配置的默认值是相同的。