[8.7] Mobile central config (#152782) (#153440)

# Backport This will backport the following commits from `main` to `8.7`: - [Mobile central config (#152782)](https://github.com/elastic/kibana/pull/152782)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)  Co-authored-by: LikeTheSalad <56847527+LikeTheSalad@users.noreply.github.com>
2025-04-24 09:48:58 -04:00 · 2023-03-22 09:11:49 -04:00 · 2023-03-22 09:11:49 -04:00 · 11a8620c5e
commit 11a8620c5e
parent f6f061e47a
4 changed files with 53 additions and 8 deletions
--- a/x-pack/plugins/apm/common/agent_configuration/setting_definitions/general_settings.ts
+++ b/x-pack/plugins/apm/common/agent_configuration/setting_definitions/general_settings.ts
@ -27,7 +27,16 @@ export const generalSettings: RawSettingDefinition[] = [
          'The maximum total compressed size of the request body which is sent to the APM Server intake api via a chunked encoding (HTTP streaming).\nNote that a small overshoot is possible.\n\nAllowed byte units are `b`, `kb` and `mb`. `1kb` is equal to `1024b`.',
      }
    ),
-    excludeAgents: ['js-base', 'rum-js', 'dotnet', 'go', 'nodejs', 'php'],
+    excludeAgents: [
+      'js-base',
+      'rum-js',
+      'dotnet',
+      'go',
+      'nodejs',
+      'php',
+      'android/java',
+      'iOS/swift',
+    ],
  },

  // API Request Time
@ -45,7 +54,16 @@ export const generalSettings: RawSettingDefinition[] = [
          "Maximum time to keep an HTTP request to the APM Server open for.\n\nNOTE: This value has to be lower than the APM Server's `read_timeout` setting.",
      }
    ),
-    excludeAgents: ['js-base', 'rum-js', 'dotnet', 'go', 'nodejs', 'php'],
+    excludeAgents: [
+      'js-base',
+      'rum-js',
+      'dotnet',
+      'go',
+      'nodejs',
+      'php',
+      'android/java',
+      'iOS/swift',
+    ],
  },

  // Capture body
@ -70,7 +88,7 @@ export const generalSettings: RawSettingDefinition[] = [
      { text: 'transactions', value: 'transactions' },
      { text: 'all', value: 'all' },
    ],
-    excludeAgents: ['js-base', 'rum-js', 'php'],
+    excludeAgents: ['js-base', 'rum-js', 'php', 'android/java', 'iOS/swift'],
  },

  {
@ -111,7 +129,14 @@ export const generalSettings: RawSettingDefinition[] = [
          'If set to `true`, the agent will capture HTTP request and response headers (including cookies), as well as message headers/properties when using messaging frameworks (like Kafka).\n\nNOTE: Setting this to `false` reduces network bandwidth, disk space and object allocations.',
      }
    ),
-    excludeAgents: ['js-base', 'rum-js', 'nodejs', 'php'],
+    excludeAgents: [
+      'js-base',
+      'rum-js',
+      'nodejs',
+      'php',
+      'android/java',
+      'iOS/swift',
+    ],
  },

  {
@ -310,7 +335,14 @@ export const generalSettings: RawSettingDefinition[] = [
          'In its default settings, the APM agent will collect a stack trace with every recorded span.\nWhile this is very helpful to find the exact place in your code that causes the span, collecting this stack trace does have some overhead. \nWhen setting this option to a negative value, like `-1ms`, stack traces will be collected for all spans. Setting it to a positive value, e.g. `5ms`, will limit stack trace collection to spans with durations equal to or longer than the given value, e.g. 5 milliseconds.\n\nTo disable stack trace collection for spans completely, set the value to `0ms`.',
      }
    ),
-    excludeAgents: ['js-base', 'rum-js', 'nodejs', 'php'],
+    excludeAgents: [
+      'js-base',
+      'rum-js',
+      'nodejs',
+      'php',
+      'android/java',
+      'iOS/swift',
+    ],
  },

  // STACK_TRACE_LIMIT
@ -385,7 +417,7 @@ export const generalSettings: RawSettingDefinition[] = [
          'Limits the amount of spans that are recorded per transaction.',
      }
    ),
-    excludeAgents: ['js-base', 'rum-js'],
+    excludeAgents: ['js-base', 'rum-js', 'android/java', 'iOS/swift'],
  },

  // Transaction sample rate
@ -403,6 +435,7 @@ export const generalSettings: RawSettingDefinition[] = [
          'By default, the agent will sample every transaction (e.g. request to your service). To reduce overhead and storage requirements, you can set the sample rate to a value between 0.0 and 1.0. We still record overall time and the result for unsampled transactions, but not context information, labels, or spans.',
      }
    ),
+    excludeAgents: ['android/java', 'iOS/swift'],
  },

  // Sanitize field names
--- a/x-pack/plugins/apm/common/agent_configuration/setting_definitions/index.test.ts
+++ b/x-pack/plugins/apm/common/agent_configuration/setting_definitions/index.test.ts
@ -180,6 +180,14 @@ describe('filterByAgent', () => {
      );
    });

+    it('android/java', () => {
+      expect(getSettingKeysForAgent('android/java')).toEqual(['recording']);
+    });
+
+    it('iOS/swift', () => {
+      expect(getSettingKeysForAgent('iOS/swift')).toEqual(['recording']);
+    });
+
    it('"All" services (no agent name)', () => {
      expect(getSettingKeysForAgent(undefined)).toEqual(
        expect.arrayContaining([
--- a/x-pack/plugins/apm/common/agent_configuration/setting_definitions/index.ts
+++ b/x-pack/plugins/apm/common/agent_configuration/setting_definitions/index.ts
@ -12,7 +12,7 @@ import { PathReporter } from 'io-ts/lib/PathReporter';
 import { AgentName } from '../../../typings/es_schemas/ui/fields/agent';
 import { booleanRt } from '../runtime_types/boolean_rt';
 import { getIntegerRt } from '../runtime_types/integer_rt';
-import { isRumAgentName } from '../../agent_name';
+import { isRumOrMobileAgent } from '../../agent_name';
 import { floatRt } from '../runtime_types/float_rt';
 import { RawSettingDefinition, SettingDefinition } from './types';
 import { generalSettings } from './general_settings';
@ -105,7 +105,7 @@ export function filterByAgent(agentName?: AgentName) {

      // only options that apply to every agent (ignoring RUM) should be returned
      if (setting.excludeAgents) {
-        return setting.excludeAgents.every(isRumAgentName);
+        return setting.excludeAgents.every(isRumOrMobileAgent);
      }

      return true;
--- a/x-pack/plugins/apm/common/agent_name.ts
+++ b/x-pack/plugins/apm/common/agent_name.ts
@ -73,6 +73,10 @@ export function isMobileAgentName(agentName?: string) {
  return isIosAgentName(agentName) || isAndroidAgentName(agentName);
 }

+export function isRumOrMobileAgent(agentName?: string) {
+  return isRumAgentName(agentName) || isMobileAgentName(agentName);
+}
+
 export function isIosAgentName(agentName?: string) {
  const lowercased = agentName && agentName.toLowerCase();
  return lowercased === 'ios/swift';