kibana/dev_docs/tutorials
Marta Bondyra 65bdf1ff8e
Optimize existing image assets with lossless compression (#223998)
## Summary

This PR applies **lossless compression** to all SVG and JPG/PNG assets
across Kibana using:

- [`svgo`](https://github.com/svg/svgo) — for optimizing SVGs  
- [`image-optimize`](https://www.npmjs.com/package/image-optimize) — for
JPG/PNG compression

‼️**Please scroll to ''Unknown metric groups" accordion to see what's
the gain for your code.**
<img width="542" alt="Screenshot 2025-06-18 at 13 24 20"
src="https://github.com/user-attachments/assets/191afb28-44fc-4551-9026-756a8385c66a"
/>

The goal is to reduce asset size and improve load performance without
compromising visual quality.

This PR achieves a **23 MB** reduction in asset size across all images
bundled in Kibana’s running code—meaning these compressed images
directly impact what ships in Kibana.
Some assets get bundled into chunks due to our bundling strategy but
might not actually be requested at runtime.

Additionally, I ran the same optimization script on the docs assets as a
harmless extra step, but those savings aren’t included in the 23 MB
total.

---

## Why

While working on Emotion rewrites, I noticed some SVGs seemed
unnecessarily heavy. That led to a broader investigation into our image
assets, and it turns out we’re not consistently optimizing them during
development or build.


---

## Notes

- Visual fidelity of optimized assets has been manually verified — no
visible differences
- The optimization is **lossless**, meaning no quality degradation
- Some assets (like large background images) could benefit further from
**lossy compression**

---

## Follow-ups / Ideas

1. **Automate compression in the dev/build pipeline**
   - e.g. add `svgo` as a pre-commit or CI step for SVGs
2. **Improve CI reporting**  
- Currently, bundle size diffs for images are hidden under "Unknown
metric groups" in the GitHub CI comment. We may want to make these more
visible.
   - 
3. **Audit large assets manually** — apply lossy compression where
appropriate
4. **Avoid redundant image loading**  
- e.g. background images on the login page are loaded again on the space
selector page since they’re bundled twice. I’m working on a separate PR
to address that.

## Snippets I used to apply the compression

```
# Find SVG files
find . -type f -iname "*.svg" \
  -not -path "*/node_modules/*" \
  -not -path "*/functional/*" > svg-files.txt

# Compress SVGs
while IFS= read -r file; do
  svgo "$file"
done < svg-files.txt
```

This snippet has been used for png and jpg, but the example below is for
png:
```
# Find PNG files
find . -type f -iname "*.png \
  -not -path "*/node_modules/*" \
  -not -path "*/functional/*" > png-files.txt

# Compress PNGs
while IFS= read -r file; do
  image-optimize -f jpg "$file"
done < png-files.txt
```
2025-06-19 16:44:13 +02:00
..
data SKA: Update broken references and URLs (#206836) 2025-01-28 03:32:48 +00:00
performance Update TTFMP documentation for meta fields. (#221807) 2025-06-11 00:14:05 +02:00
screenshotting Optimize existing image assets with lossless compression (#223998) 2025-06-19 16:44:13 +02:00
advanced_settings.mdx [Advanced settings] Update migration guidance in advanced settings tutorial (#208010) 2025-01-29 14:42:29 +01:00
apm_ui.png Optimize existing image assets with lossless compression (#223998) 2025-06-19 16:44:13 +02:00
building_a_kibana_distributable.mdx [api-docs] follow the correct schema for frontmatter (#138348) 2022-08-10 17:17:50 -05:00
ci.mdx [Security Assistant] Adds BuildKite pipeline for running Security GenAI Evaluations weekly (#215254) 2025-04-24 11:46:57 -06:00
configuring_cross_cluster_search.mdx [dev docs] How to set up cross cluster search locally (#182025) 2024-04-30 12:46:21 -05:00
data_views.mdx [api-docs] follow the correct schema for frontmatter (#138348) 2022-08-10 17:17:50 -05:00
debugging.mdx [Dev Docs] Add VS Code configurations to Dev Docs Debugging Tutorial (#212807) 2025-03-06 10:14:19 -05:00
debugging_fips_test_failures.mdx Update FIPS Test Failure Debugging docs to mention backport branch (#219728) 2025-04-30 10:44:39 -04:00
development_windows.mdx [api-docs] follow the correct schema for frontmatter (#138348) 2022-08-10 17:17:50 -05:00
endpoints.mdx Deprecated authRequired in favor of security.authc.enabled (#202414) 2024-12-10 11:24:41 +01:00
expressions.mdx [api-docs] follow the correct schema for frontmatter (#138348) 2022-08-10 17:17:50 -05:00
fips_test_failure_license_override_example.png Optimize existing image assets with lossless compression (#223998) 2025-06-19 16:44:13 +02:00
generating_oas_for_http_apis.mdx Update generating_oas_for_http_apis.mdx (#221825) 2025-06-03 12:44:50 +02:00
kibana_page_template.mdx Upgrade EUI to v63.0.6 - updates to new EuiPageTemplate and deprecates old page components (#139524) 2022-09-07 15:35:23 -05:00
saved_objects.mdx Revert "Removed switchToModelVersionAt from SO API definition (#219029)" (#220059) 2025-05-05 16:01:45 +02:00
submit_a_pull_request.mdx [ci] Remove duplicate backport action (#190643) 2024-08-20 08:23:25 -05:00
testing_plugins.mdx Updates internal dev docs for Saved Objects (#178058) 2024-03-07 08:16:28 -07:00
versioning_http_apis.mdx [dev-docs] Adds section explaining internal and public APIs (#195840) 2024-10-11 16:16:47 +00:00
versioning_interfaces.mdx [Versioned APIs] Versioned interfaces dev docs guide (#150705) 2023-03-01 16:45:43 +01:00