Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[APM] ensure rum_allow_origins setting only saves valid YAML strings #128704

Merged
merged 1 commit into from
Mar 29, 2022
Merged

[APM] ensure rum_allow_origins setting only saves valid YAML strings #128704

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion x-pack/plugins/apm/server/routes/fleet/create_cloud_apm_package_policy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import {
import { getApmPackagePolicyDefinition } from './get_apm_package_policy_definition';
import { Setup } from '../../lib/helpers/setup_request';
import { mergePackagePolicyWithApm } from './merge_package_policy_with_apm';
import { ELASTIC_CLOUD_APM_AGENT_POLICY_ID } from '../../../common/fleet';

export async function createCloudApmPackgePolicy({
cloudPluginSetup,
Expand Down Expand Up @@ -65,7 +66,7 @@ export async function createCloudApmPackgePolicy({
savedObjectsClient,
esClient,
mergedAPMPackagePolicy,
{ force: true, bumpRevision: true }
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This ensures the package policy ID is set correct. There was a bug previously in #128496 .

{ id: ELASTIC_CLOUD_APM_AGENT_POLICY_ID, force: true, bumpRevision: true }
);
logger.info(`Fleet migration on Cloud - apmPackagePolicy create end`);
return apmPackagePolicy;
Expand Down
23 changes: 21 additions & 2 deletions x-pack/plugins/apm/server/routes/fleet/get_apm_package_policy_definition.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
* 2.0.
*/

import yaml from 'js-yaml';
import { KibanaRequest } from 'kibana/server';
import { RegistryVarsEntry } from '../../../../fleet/common';
import {
POLICY_ELASTIC_AGENT_ON_CLOUD,
INPUT_VAR_NAME_TO_SCHEMA_PATH,
ELASTIC_CLOUD_APM_AGENT_POLICY_ID,
} from '../../../common/fleet';
import {
APMPluginSetupDependencies,
Expand All @@ -36,7 +36,6 @@ export async function getApmPackagePolicyDefinition({
});

return {
id: ELASTIC_CLOUD_APM_AGENT_POLICY_ID,
name: 'Elastic APM',
namespace: 'default',
enabled: true,
Expand Down Expand Up @@ -73,6 +72,9 @@ function getApmPackageInputVars({
}): Record<string, { type: string; value: any }> {
const overrideValues: Record<string, any> = {
url: cloudPluginSetup?.apm?.url, // overrides 'apm-server.url' to be the cloud APM host
rum_allow_origins: ensureValidMultiText(
apmServerSchema[INPUT_VAR_NAME_TO_SCHEMA_PATH.rum_allow_origins]
), // fixes issue where "*" needs to be wrapped in quotes to be parsed as a YAML string
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is specific to rum_allow_origins since it's the only type: "text", multi: true input var that accepts wildcard string values (allows all origins). But we could apply this to all similar values if we want to.

};

return policyTemplateInputVars.reduce((acc, registryVarsEntry) => {
Expand All @@ -90,3 +92,20 @@ function getApmPackageInputVars({
};
}, {});
}

function ensureValidMultiText(textMultiValue: string[] | undefined) {
if (!textMultiValue) {
return undefined;
}
return textMultiValue.map(escapeInvalidYamlString);
}
function escapeInvalidYamlString(yamlString: string) {
try {
yaml.load(yamlString);
} catch (error) {
if (error instanceof yaml.YAMLException) {
return `"${yamlString}"`;
}
}
return yamlString;
}