From ed7c62ea356b5d2b6b7a36f5b756c6db95595077 Mon Sep 17 00:00:00 2001
From: Sam Batschelet <sam.batschelet@avalabs.org>
Date: Tue, 2 May 2023 09:04:34 -0400
Subject: [PATCH] trace: add docs on mmap limits for elasticsearch container

Signed-off-by: Sam Batschelet <sam.batschelet@avalabs.org>
---
 trace/zipkin.yml | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/trace/zipkin.yml b/trace/zipkin.yml
index 1653ae8d84..6b2941fca1 100644
--- a/trace/zipkin.yml
+++ b/trace/zipkin.yml
@@ -4,6 +4,8 @@
 version: '2.4'
 
 services:
+  # Default mmap count limits on most systems is too low resulting in memory exceptions.
+  # ref. https://www.elastic.co/guide/en/elasticsearch/reference/current/vm-max-map-count.html
   db:
     image: ghcr.io/openzipkin/zipkin-elasticsearch7:latest
     container_name: elasticsearch