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.

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] Allow 'sourcemap' property on APM indices API #177820

Closed
cauemarcondes opened this issue Feb 27, 2024 · 1 comment · Fixed by #177847
Closed

[APM] Allow 'sourcemap' property on APM indices API #177820

cauemarcondes opened this issue Feb 27, 2024 · 1 comment · Fixed by #177847
Labels
bug Fixes for quality problems that affect the customer experience Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team

Comments

@cauemarcondes
Copy link
Contributor

Before 8.7 we allowed users to update the sourcemap index name on the APM settings page. This field got removed on this PR, so the UI no longer have this field available.

There is a backwards compatibility problem here. When users updated this field before 8.7 and upgraded to a newer version they are no longer able to change their APM indices on the page. They'll be thrown this error from the API:

Excess keys are not allowed:\nbody.sourcemap

How to fix it:

  • We must allow the legacy sourcemap to the API payload type definition here.
@cauemarcondes cauemarcondes added bug Fixes for quality problems that affect the customer experience Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team labels Feb 27, 2024
@elasticmachine
Copy link
Contributor

Pinging @elastic/obs-ux-infra_services-team (Team:obs-ux-infra_services)

cauemarcondes added a commit that referenced this issue Mar 4, 2024
closes #177820

Saved Object before: 

```
 "attributes": {
    "apmIndices": {
      "onboarding": "caue",
      "sourcemap": "foo-*"
    },
    "isSpaceAware": true
  },
```
<img width="1826" alt="Screenshot 2024-02-28 at 17 47 12"
src="https://github.com/elastic/kibana/assets/55978943/e44d90ec-982c-4330-88dc-14f0f59bfce7">

Saved Object after:
```
"attributes": {
    "apmIndices": {
      "onboarding": "caue"
    },
    "isSpaceAware": true
  },
```

The API now accepts the `sourcemap` param.
kibanamachine pushed a commit to kibanamachine/kibana that referenced this issue Mar 4, 2024
closes elastic#177820

Saved Object before:

```
 "attributes": {
    "apmIndices": {
      "onboarding": "caue",
      "sourcemap": "foo-*"
    },
    "isSpaceAware": true
  },
```
<img width="1826" alt="Screenshot 2024-02-28 at 17 47 12"
src="https://github.com/elastic/kibana/assets/55978943/e44d90ec-982c-4330-88dc-14f0f59bfce7">

Saved Object after:
```
"attributes": {
    "apmIndices": {
      "onboarding": "caue"
    },
    "isSpaceAware": true
  },
```

The API now accepts the `sourcemap` param.

(cherry picked from commit 505b928)
kibanamachine referenced this issue Mar 4, 2024
…177933)

# Backport

This will backport the following commits from `main` to `8.13`:
- [[APM] Update Indices API to support sourcemap param
(#177847)](#177847)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Cauê
Marcondes","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-03-04T13:26:30Z","message":"[APM]
Update Indices API to support sourcemap param (#177847)\n\ncloses
https://github.com/elastic/kibana/issues/177820\r\n\r\nSaved Object
before: \r\n\r\n```\r\n \"attributes\": {\r\n \"apmIndices\": {\r\n
\"onboarding\": \"caue\",\r\n \"sourcemap\": \"foo-*\"\r\n },\r\n
\"isSpaceAware\": true\r\n },\r\n```\r\n<img width=\"1826\"
alt=\"Screenshot 2024-02-28 at 17 47
12\"\r\nsrc=\"https://github.com/elastic/kibana/assets/55978943/e44d90ec-982c-4330-88dc-14f0f59bfce7\">\r\n\r\nSaved
Object after:\r\n```\r\n\"attributes\": {\r\n \"apmIndices\": {\r\n
\"onboarding\": \"caue\"\r\n },\r\n \"isSpaceAware\": true\r\n
},\r\n```\r\n\r\nThe API now accepts the `sourcemap`
param.","sha":"505b928dc1e30a70a2e4fe9d966e03174b2fbc2c","branchLabelMapping":{"^v8.14.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:fix","Team:obs-ux-infra_services","v8.13.0","v8.14.0"],"title":"[APM]
Update Indices API to support sourcemap
param","number":177847,"url":"https://github.com/elastic/kibana/pull/177847","mergeCommit":{"message":"[APM]
Update Indices API to support sourcemap param (#177847)\n\ncloses
https://github.com/elastic/kibana/issues/177820\r\n\r\nSaved Object
before: \r\n\r\n```\r\n \"attributes\": {\r\n \"apmIndices\": {\r\n
\"onboarding\": \"caue\",\r\n \"sourcemap\": \"foo-*\"\r\n },\r\n
\"isSpaceAware\": true\r\n },\r\n```\r\n<img width=\"1826\"
alt=\"Screenshot 2024-02-28 at 17 47
12\"\r\nsrc=\"https://github.com/elastic/kibana/assets/55978943/e44d90ec-982c-4330-88dc-14f0f59bfce7\">\r\n\r\nSaved
Object after:\r\n```\r\n\"attributes\": {\r\n \"apmIndices\": {\r\n
\"onboarding\": \"caue\"\r\n },\r\n \"isSpaceAware\": true\r\n
},\r\n```\r\n\r\nThe API now accepts the `sourcemap`
param.","sha":"505b928dc1e30a70a2e4fe9d966e03174b2fbc2c"}},"sourceBranch":"main","suggestedTargetBranches":["8.13"],"targetPullRequestStates":[{"branch":"8.13","label":"v8.13.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.14.0","branchLabelMappingKey":"^v8.14.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/177847","number":177847,"mergeCommit":{"message":"[APM]
Update Indices API to support sourcemap param (#177847)\n\ncloses
https://github.com/elastic/kibana/issues/177820\r\n\r\nSaved Object
before: \r\n\r\n```\r\n \"attributes\": {\r\n \"apmIndices\": {\r\n
\"onboarding\": \"caue\",\r\n \"sourcemap\": \"foo-*\"\r\n },\r\n
\"isSpaceAware\": true\r\n },\r\n```\r\n<img width=\"1826\"
alt=\"Screenshot 2024-02-28 at 17 47
12\"\r\nsrc=\"https://github.com/elastic/kibana/assets/55978943/e44d90ec-982c-4330-88dc-14f0f59bfce7\">\r\n\r\nSaved
Object after:\r\n```\r\n\"attributes\": {\r\n \"apmIndices\": {\r\n
\"onboarding\": \"caue\"\r\n },\r\n \"isSpaceAware\": true\r\n
},\r\n```\r\n\r\nThe API now accepts the `sourcemap`
param.","sha":"505b928dc1e30a70a2e4fe9d966e03174b2fbc2c"}}]}]
BACKPORT-->

---------

Co-authored-by: Cauê Marcondes <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Fixes for quality problems that affect the customer experience Team:obs-ux-infra_services Observability Infrastructure & Services User Experience Team
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants