elastic/kibana

[APM] Remove usage of `getDocumentTypeFilterForTransactions`

Open

#167,020 创建于 2023年9月22日

在 GitHub 查看
 (6 评论) (0 反应) (0 负责人)TypeScript (19,065 star) (8,021 fork)batch import
Team:obs-ux-infra_services - DEPRECATEDapm:service-metricsapm:transaction-metricsgood first issuetechnical debt

描述

Background

The APM UI is able to render using several different datasets:

  • raw transaction events
  • transaction metrics
  • service transaction metrics

The metric sets are further broken into intervals: 1m, 10m and 60m.

The UI should transparently use the most suitable, available dataset. This is what GET /internal/apm/time_range_metadata is for: it will decide which datasets are available for a given time range.

Problem

Currently some APIs like GET /internal/apm/services uses the time_range_metadata API for querying whilst other APIs like GET /internal/apm/services/{serviceName}/transaction_types do not and thus perform their own logic for determining which data to query. This results in some inconsistencies and outright bugs like seen in https://github.com/elastic/sdh-apm/issues/1078 (internal).

Solution

Every API that consumes (service) transaction metrics should use the information from time range metadata API as inputs. Specifically we should remove all usages of getDocumentTypeFilterForTransactions(searchAggregatedTransactions).

In some places we also call getDocumentTypeFilterForTransactions(true). We will still need this but it should be renamed to something likegetBackwardsCompatibleDocumentTypeFilterForOneMinuteTransactionMetrics().

Related

https://github.com/elastic/sdh-apm/issues/1078 https://github.com/elastic/kibana/pull/167500 (initial implementation)

贡献者指南

技术栈
typescriptnodejsrest api
领域
backend
议题类型
refactor
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
3-5 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
active
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Familiarity with Elastic APMUnderstanding of Kibana's internal APIsExperience with TypeScript
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
40
研究方向
First, locate all usages of `getDocumentTypeFilterForTransactions` in the Kibana codebase. This function is likely in the APM plugin. The issue specifies that some APIs, like `GET /internal/apm/services`, already use the time range metadata API, while others, like `GET /internal/apm/services/{serviceName}/transaction types`, do not. For each usage, determine if it should be replaced with logic based on time range metadata. Additionally, rename calls with `getDocumentTypeFilterForTransactions(true)` to `getBackwardsCompatibleDocumentTypeFilterForOneMinuteTransactionMetrics()`. Refer to the initial implementation in PR #167500 and the related issue #1078 for context. Ensure no breaking changes and that all tests pass.
[APM] Remove usage of `getDocumentTypeFilterForTransactions` · elastic/kibana#167020 | Good First Issue