帮助手册

应用参数

应用参数允许您将任意指标注入到应用程序上下文中。此功能使平台能够观察和监控默认监控设置可能未捕获的关键绩效指标(KPI)。

通过应用参数,您可以监控:

  • 变量的大小、数值或频率。
  • 应用程序中某个操作的大小或频率。

假设一个简单的 Web 请求涉及一次 API 调用、一次数据库(DB)操作和一次缓存命中;一个请求可以调用多个资源,多个用户可以同时发起多个请求。在这种情况下,您可以了解 API 被调用的频率,以及在特定时间间隔内 DB 操作发生的次数。这有助于评估 CPU 或内存是否过载,以及这对特定时间间隔内应用程序性能的影响。 

在实际应用中,应用参数功能在监控 DB 调用、服务调用或用户自定义框架调用的命中频率时非常有用。根据应用参数中的报表,您可以排查因命中过多导致的性能降级问题。  

开始使用应用参数:

涉及的操作

1. 求和 

  • 特定间隔内为某参数传递的所有值之和。

2. 平均值

  • 特定间隔内为某参数传递的平均值。

每个参数将附带以下指标发送,以跟踪其频率:

求和:

1. 参数名称:

  • 用户在应用程序中提供的参数名称。

2. 总值:

  • 特定间隔内对应参数的聚合值。

平均值:

1. 参数名称:

  • 用户在应用程序中提供的参数名称。

2. 总值:

  • 特定间隔内对应参数的聚合值。

3. 最小值:

  • 该特定间隔内捕获的最小值。

4. 最大值:

  • 该特定间隔内捕获的最大值。

5. 总计数:

  • 命中总次数。

应用参数 API 适用于 .NET 和 Java 代理。请按照以下说明开始使用。

.NET 和 .NET Core 应用程序

  1. 根据您的应用程序环境安装 APM Insight .NET 代理 或 APM Insight .NET Core 代理
  2. 从 NuGet 包管理器下载或引用 Site24x7.Agent.Api 包到您的应用程序项目中。
    注意

    该 API 有一个名为 Site24x7.Agent.Api 的类,用于跟踪应用程序代码的性能。

求和

特定间隔内为某参数传递的值之和。如果求和为空值,则将增加 1。

                 Site24x7.Agent.Api.Increment("keyName");
                 Site24x7.Agent.Api.Increment("keyName", value);

平均值

特定间隔内为某参数传递的值的平均值。

Site24x7.Agent.Api.Average("keyName", value);

参数名称

描述

 keyName

要监控的应用参数的名称

incrementalValue

应用参数键将按此递增。

         averagingValue

         应用参数键将按此计算平均值。

4. 在需要的地方添加以上代码片段:

示例

public ActionResult Register()
{
         DateTime st = DateTime.Now;
         double myKeyValue = Convert.ToDouble(Request.QueryString["mykey"]);
         //parameter "register" will be incremented by 1 and sent as SUM  
         Site24x7.Agent.Api.Increment("register");
         //parameter "mykey" will be incremented by myKeyValue and sent as SUM
         Site24x7.Agent.Api.Increment("mykey", myKeyValue);
         double myKeyAvgValue = GetAverageValue();
         //parameter "myavgkey" will be incremented by value and sent as AVG
         Site24x7.Agent.Api.Average("myavgkey", myKeyAvgValue);
         return View();
}

5.  发布应用程序以开始跟踪参数。

Java 应用程序

  1. 安装 APM Insight Java 代理
  2. 确保 满足前提条件。将应用程序构建路径中的 API jar(apminsight-javaagent-api.jar)打包进来。首选位置为 WEB-INF/lib。
  3. 在需要的地方添加以下代码片段。
   语法:

求和

CustomMetric.increment("key_name")

键的值将增加 1。每次代理轮询间隔后键将被清除。 

CustomMetric.increment("key_name", value)

键的值将按指定值递增。每次代理轮询间隔后键将被清除。

平均值

CustomMetric.average("key_name", value)

键的值将被聚合,其计数由代理收集并推送到 Site24x7 的服务器。

示例: 

private void generateReport(String type)

{

CustomMetric.increment(type);

// Other app operations

double averageValue = getAverageValue();

CustomMetric.average(type, averageValue);

 

 PHP 应用程序

  1. 根据您的应用程序环境,安装适用于 WindowsLinux 的 APM Insight PHP 代理。
  2. 在 PHP 脚本中需要的地方添加以下代码片段。
            语法:

求和

zpa_app_param_increment(“keyName”);

键的值将增加 1。每次代理轮询间隔后键将被清除。

zpa_app_param_increment(“keyName”,value);

指定值将递增键的值。每次代理轮询间隔后键将被清除。

平均值

特定间隔内为某参数传递的值的平均值。

zpa_app_param_avg(“keyName”,value);

查看应用参数

  1. 登录您的 Site24x7 账户 > 您的应用程序 > 应用参数。
  2. 为操作/变量创建的应用参数将列在右侧,并附有您提供的名称和参数类型(求和或平均值)。
  3. 单击您希望查看的参数;您可以创建、保存和更新视图以供将来参考。

 


相关文章

Node.js 应用程序的应用参数

本文档对您有帮助吗?

您愿意帮助我们改进文档吗?请告诉我们哪些方面可以做得更好。


很抱歉本文档未能让您满意。我们希望了解可以从哪些方面改进您的体验。


感谢您抽出时间分享反馈。我们将利用您的反馈来改进在线帮助资源。

短链接已复制!