id
stringlengths
36
36
document
stringlengths
3
3k
metadata
stringlengths
23
69
embeddings
listlengths
384
384
e6a724b9-fab5-4e8a-942f-bc30f9344fd2
curl -O https://datasets-documentation.s3.eu-west-3.amazonaws.com/clickstack-integrations/redis/redis-metrics-gauge.csv Download sum metrics (commands, connections, keyspace stats) curl -O https://datasets-documentation.s3.eu-west-3.amazonaws.com/clickstack-integrations/redis/redis-metrics-sum.csv ``` The dataset...
{"source_file": "redis-metrics.md"}
[ -0.0500088669359684, -0.0498737096786499, -0.10094906389713287, 0.03642164170742035, 0.01509862206876278, -0.11923433840274811, 0.006033559795469046, -0.05193588137626648, 0.03178910166025162, 0.05017535015940666, -0.014506377279758453, -0.025819679722189903, -0.002951997797936201, -0.1103...
d616cdd5-f707-465c-96f6-9becc7141c64
Verify the environment variable CUSTOM_OTELCOL_CONFIG_FILE is set correctly: bash docker exec <container-name> printenv CUSTOM_OTELCOL_CONFIG_FILE Check that the custom config file is mounted at /etc/otelcol-contrib/custom.config.yaml : bash docker exec <container-name> ls -lh /etc/otelcol-contrib/custom.config....
{"source_file": "redis-metrics.md"}
[ 0.06799619644880295, -0.013163023628294468, -0.0804479569196701, -0.05310266464948654, -0.033323001116514206, -0.09106576442718506, 0.06674692034721375, -0.005358983296900988, 0.020952684804797173, 0.0022511847782880068, 0.010494519956409931, -0.09862127900123596, 0.004563534166663885, -0....
dcf58de7-aa78-4002-bdf7-d1c03d788d03
slug: /use-cases/observability/clickstack/integrations/redis title: 'Monitoring Redis Logs with ClickStack' sidebar_label: 'Redis Logs' pagination_prev: null pagination_next: null description: 'Monitoring Redis Logs with ClickStack' doc_type: 'guide' import Image from '@theme/IdealImage'; import useBaseUrl from '@d...
{"source_file": "redis-logs.md"}
[ -0.0037665748968720436, -0.03515224531292915, -0.07588908821344376, -0.011825545690953732, 0.0497467927634716, -0.07100003957748413, 0.07200739532709122, 0.052140459418296814, 0.003803045954555273, 0.029212206602096558, 0.006858589127659798, -0.004934593569487333, 0.07291386276483536, 0.02...
5b73a170-ccb1-4e08-93c6-0e63b7acddc3
```bash For systemd sudo systemctl restart redis For Docker docker restart ``` Create custom OTel collector configuration {#custom-otel} ClickStack allows you to extend the base OpenTelemetry Collector configuration by mounting a custom configuration file and setting an environment variable. The custom co...
{"source_file": "redis-logs.md"}
[ 0.013293891213834286, 0.01820693165063858, -0.02999163791537285, -0.014856746420264244, -0.023156531155109406, -0.08574962615966797, 0.09899220615625381, -0.009247280657291412, 0.009556782431900501, 0.031189555302262306, -0.012545234523713589, -0.06450742483139038, -0.007188971154391766, -...
c300ced0-4ea4-41d5-be48-ba8c21981559
Mount your Redis log directory so the collector can read them Option 1: Docker Compose {#docker-compose} Update your ClickStack deployment configuration: yaml services: clickstack: # ... existing configuration ... environment: - CUSTOM_OTELCOL_CONFIG_FILE=/etc/otelcol-contrib/custom.config.yaml ...
{"source_file": "redis-logs.md"}
[ 0.02472330443561077, -0.06040278077125549, -0.07244861125946045, 0.0030753014143556356, 0.007328591775149107, -0.11638133227825165, 0.06470915675163269, -0.0070553855039179325, 0.05586288124322891, 0.01692136749625206, 0.0017727285157889128, -0.08016262948513031, 0.023046530783176422, -0.0...
6655f338-13c8-480b-8562-41d39c7de9ec
Run ClickStack with demo configuration {#run-demo} Run ClickStack with the demo logs and configuration: bash docker run --name clickstack-demo \ -p 8080:8080 -p 4317:4317 -p 4318:4318 \ -e CUSTOM_OTELCOL_CONFIG_FILE=/etc/otelcol-contrib/custom.config.yaml \ -v "$(pwd)/redis-demo.yaml:/etc/otelcol-contrib/cust...
{"source_file": "redis-logs.md"}
[ 0.05395679920911789, -0.04939109459519386, -0.0428612045943737, -0.028395220637321472, 0.003343382617458701, -0.10877401381731033, 0.07109373062849045, -0.02567342296242714, -0.006273228675127029, 0.042892590165138245, 0.021403055638074875, -0.03194907307624817, -0.0057763303630054, -0.025...
964445c3-bddd-47fd-a354-933eb6e779ee
Example: 1) "logfile" 2) "/var/log/redis/redis-server.log" ``` Check Redis is actively logging: ```bash tail -f /var/log/redis/redis-server.log Should show recent log entries in Redis format ``` Verify the collector can read the logs: ```bash docker exec cat /var/log/redis/redis-server.log Should displa...
{"source_file": "redis-logs.md"}
[ 0.05847792327404022, -0.020563706755638123, -0.041637130081653595, -0.015786435455083847, 0.06170469895005226, -0.10382796078920364, 0.016401980072259903, -0.0049684783443808556, 0.048757683485746384, 0.024603109806776047, -0.03712964057922363, -0.06676007062196732, -0.0019124087411910295, ...
41682c3a-4236-4948-bc6c-8223b1e9f7be
slug: /use-cases/observability/clickstack/integration-guides pagination_prev: null pagination_next: null description: 'Data ingestion for ClickStack - The ClickHouse Observability Stack' title: 'Integration guides' doc_type: 'landing-page' keywords: ['ClickStack data ingestion', 'observability data ingestion', 'ClickSt...
{"source_file": "index.md"}
[ -0.004850368481129408, -0.05687221512198448, -0.05240989103913307, 0.008204928599298, 0.0035686506889760494, -0.043543461710214615, 0.0199408158659935, 0.014729971066117287, -0.08143217861652374, 0.015217257663607597, 0.031621597707271576, 0.0062541598454117775, 0.013240103609859943, -0.00...
2b5aa7d2-4535-4022-b9a1-f748f57c320f
slug: /use-cases/observability/clickstack/integrations/nginx-traces title: 'Monitoring Nginx Traces with ClickStack' sidebar_label: 'Nginx Traces' pagination_prev: null pagination_next: null description: 'Monitoring Nginx Traces with ClickStack' doc_type: 'guide' keywords: ['ClickStack', 'Nginx', 'traces', 'otel'] ...
{"source_file": "nginx-traces.md"}
[ -0.03534109890460968, -0.007549702655524015, -0.01046042237430811, 0.001356367371045053, 0.056562986224889755, -0.017313692718744278, 0.07250862568616867, 0.008950424380600452, -0.016924403607845306, 0.02911790832877159, -0.006005225703120232, -0.025432586669921875, 0.030003417283296585, 0...
e39cd482-1ab1-40a0-b3c7-6515a9257052
Add OpenTelemetry configuration to your nginx.conf file. The configuration loads the module and directs traces to ClickStack's OTLP endpoint. First, get your API key: 1. Open HyperDX at your ClickStack URL 2. Navigate to Settings → API Keys 3. Copy your Ingestion API Key 4. Set it as an environment variable: ex...
{"source_file": "nginx-traces.md"}
[ -0.01631542667746544, -0.028578219935297966, 0.03843893110752106, -0.027353793382644653, -0.03074263222515583, -0.05908844247460365, 0.06212064251303673, -0.01954401284456253, 0.006062866188585758, 0.011870876885950565, -0.05709182843565941, -0.052377816289663315, -0.04188387840986252, 0.0...
5fe20d12-b544-4289-bf82-0163cbfe0db0
Start ClickStack {#start-clickstack} If you don't have ClickStack running yet, start it with: bash docker run --name clickstack-demo \ -p 8080:8080 -p 4317:4317 -p 4318:4318 \ docker.hyperdx.io/hyperdx/hyperdx-all-in-one:latest Wait about 30 seconds for ClickStack to fully initialize before proceeding. Po...
{"source_file": "nginx-traces.md"}
[ -0.009110397659242153, -0.03073914535343647, -0.058045756071805954, -0.048963434994220734, 0.0011549392947927117, -0.05815936252474785, 0.051898520439863205, -0.07341953366994858, -0.048604730516672134, 0.04192099720239639, 0.007555720396339893, -0.0507032684981823, -0.04446195065975189, -...
5046a061-2600-4fd0-9671-e45b5d12f109
:::note Ensure the time range is set to 2025-10-26 13:00:00 - 2025-10-27 13:00:00. The imported dashboard will not have a time range specified by default. ::: Troubleshooting {#troubleshooting} No traces appearing in HyperDX {#no-traces} Verify nginx module is loaded: bash nginx -V 2>&1 | grep otel You sho...
{"source_file": "nginx-traces.md"}
[ 0.006064427550882101, 0.005038702394813299, 0.0007168403244577348, -0.043950293213129044, -0.016843512654304504, -0.06116104871034622, -0.01904257945716381, -0.04627607390284538, 0.011556437239050865, 0.0070178271271288395, -0.029743602499365807, -0.07639286667108536, -0.0205638837069273, ...
69fa03e3-5a0e-4086-a09d-c4fd373b811b
slug: /use-cases/observability/clickstack/deployment/hyperdx-only title: 'HyperDX Only' pagination_prev: null pagination_next: null sidebar_position: 4 description: 'Deploying HyperDX only' doc_type: 'guide' keywords: ['HyperDX standalone deployment', 'HyperDX ClickHouse integration', 'deploy HyperDX only', 'HyperDX Do...
{"source_file": "hyperdx-only.md"}
[ 0.063600093126297, 0.03226936236023903, 0.030453724786639214, -0.07149883359670639, -0.023623080924153328, -0.02138376235961914, 0.009117663837969303, 0.006401530932635069, -0.08776586502790451, 0.023936590179800987, 0.07367029786109924, -0.013594541698694229, 0.05364665389060974, 0.024637...
98f51830-264f-4c45-ac48-52c78d47e356
Using Docker Compose {#using-docker-compose} Users can modify the Docker Compose configuration to achieve the same effect as this guide, removing the OTel collector and ClickHouse instance from the manifest. ClickStack OpenTelemetry collector {#otel-collector} Even if you are managing your own OpenTelemetry col...
{"source_file": "hyperdx-only.md"}
[ 0.044279903173446655, 0.037630800157785416, 0.022538969293236732, 0.01487311627715826, -0.03898587450385094, -0.060873597860336304, 0.0274004265666008, -0.029880471527576447, -0.05552835389971733, -0.004897674545645714, 0.007387807127088308, -0.08309972286224365, 0.00920410268008709, -0.02...
bdf49e37-8c2f-49d6-a01f-4936e82dc3b9
slug: /use-cases/observability/clickstack/deployment/helm title: 'Helm' pagination_prev: null pagination_next: null sidebar_position: 2 description: 'Deploying ClickStack with Helm - The ClickHouse Observability Stack' doc_type: 'guide' keywords: ['ClickStack Helm chart', 'Helm ClickHouse deployment', 'HyperDX Helm ins...
{"source_file": "helm.md"}
[ 0.0387788787484169, 0.029133155941963196, 0.032648250460624695, -0.08298135548830032, -0.016126470640301704, -0.0077989064157009125, -0.008222896605730057, 0.0006320125539787114, -0.04273306950926781, 0.03421974927186966, 0.07227541506290436, -0.023505259305238724, 0.027617238461971283, -0...
fc69a682-cda7-4d67-8746-77bd119d03be
Navigate to the UI {#navigate-to-the-ui} Visit http://localhost:8080 to access the HyperDX UI. Create a user, providing a username and password which means the requirements. On clicking Create , data sources will be created for the ClickHouse instance deployed with the Helm chart. :::note Overriding defau...
{"source_file": "helm.md"}
[ 0.05658630281686783, -0.02833399921655655, 0.004763770382851362, -0.04164809733629227, -0.0907754898071289, 0.01900622434914112, -0.04218500852584839, -0.02984408102929592, -0.06570640951395035, 0.029472850263118744, 0.009624801576137543, -0.057603348046541214, 0.06439360976219177, -0.0294...
961780f6-98e3-4463-a808-29d9a4d75951
```shell specify ClickHouse Cloud credentials export CLICKHOUSE_URL= # full https url export CLICKHOUSE_USER= export CLICKHOUSE_PASSWORD= how to overwrite default connection helm install myrelease hyperdx-helm --set clickhouse.enabled=false --set clickhouse.persistence.enabled=false --set otel.clickhouseEndpo...
{"source_file": "helm.md"}
[ 0.051194027066230774, 0.010437047109007835, -0.021995248273015022, -0.05548517033457756, -0.07114523649215698, -0.0038054194301366806, 0.023924434557557106, -0.053916316479444504, 0.010714703239500523, 0.017450084909796715, 0.004893594887107611, -0.0649024248123169, 0.01938122883439064, -0...
cccf2d46-c4cd-496a-8398-ff13bd046421
shell kubectl logs -l app.kubernetes.io/name=hdx-oss-v2 Debugging a failed install {#debugging-a-failed-instance} shell helm install my-hyperdx hyperdx/hdx-oss-v2 --debug --dry-run Verifying deployment {#verifying-deployment} shell kubectl get pods -l app.kubernetes.io/name=hdx-oss-v2 Users can set these en...
{"source_file": "helm.md"}
[ 0.11083381623029709, 0.018020570278167725, 0.06485382467508316, -0.06189696118235588, -0.03529979661107063, -0.00044137446093373, -0.0034946808591485023, -0.011807100847363472, 0.019632691517472267, 0.03290179744362831, -0.019300365820527077, -0.1407085806131363, 0.007065249141305685, -0.0...
117f9181-538d-43c4-b1ef-b5a5b83b2305
slug: /use-cases/observability/clickstack/deployment/all-in-one title: 'All in one' pagination_prev: null pagination_next: null sidebar_position: 0 description: 'Deploying ClickStack with All In One - The ClickHouse Observability Stack' doc_type: 'guide' keywords: ['ClickStack', 'observability', 'all-in-one', 'deployme...
{"source_file": "all-in-one.md"}
[ -0.003512762254104018, 0.01931786723434925, -0.0063410415314137936, -0.06856505572795868, 0.0010124114342033863, -0.04210827872157097, 0.02986784465610981, 0.004539051558822393, -0.107480488717556, 0.042163949459791183, 0.07078465074300766, 0.0060747102834284306, 0.02693595550954342, 0.037...
f66c234b-f1d2-4bde-9633-68e51b22e2a8
Lack of component isolation: All components run within a single Docker container. This prevents independent scaling and monitoring and applies any cgroup limits globally to all processes. As a result, components may compete for CPU and memory. Customizing ports {#customizing-ports-deploy} If you need to custom...
{"source_file": "all-in-one.md"}
[ 0.08296427875757217, 0.07421811670064926, 0.014040614478290081, -0.049527473747730255, -0.06746389716863632, -0.037023913115262985, -0.027344556525349617, -0.051511332392692566, -0.051839668303728104, 0.015628451481461525, -0.01053847186267376, -0.017731567844748497, 0.0034342894796282053, ...
048683d3-ff3f-4a7b-b747-0d7411bd2e80
slug: /use-cases/observability/clickstack/deployment title: 'Deployment Options' pagination_prev: null pagination_next: null description: 'Deploying ClickStack - The ClickHouse Observability Stack' doc_type: 'reference' keywords: ['ClickStack', 'observability'] ClickStack provides multiple deployment options to sui...
{"source_file": "index.md"}
[ 0.0017966771265491843, -0.0671667754650116, -0.033655691891908646, -0.04110239818692207, -0.025636306032538414, -0.015035896562039852, 0.030585043132305145, -0.015257496386766434, -0.09636940807104111, 0.03655984625220299, 0.0756879523396492, 0.027337975800037384, 0.05294758453965187, 0.02...
ccd24255-14f3-4312-85ec-21a905d2613f
| Name | Description | Suitable For | Limitations ...
{"source_file": "index.md"}
[ -0.008487093262374401, 0.0301436185836792, -0.014220875687897205, 0.013221750035881996, -0.0038214123342186213, 0.02592265047132969, -0.02730853296816349, 0.004372443072497845, -0.024236353114247322, -0.048795435577631, 0.016415731981396675, -0.049091681838035583, 0.029976433143019676, -0....
8c49be4c-40e4-4114-9f63-fd7acdbeebe9
HyperDX Only | | Local Mode Only | Runs entirely in the browser with local storage. No backend or persistence. | Demos, debugging, dev with HyperDX | No auth, no persistence, no alert...
{"source_file": "index.md"}
[ 0.12551958858966827, 0.012889059260487556, 0.005798893049359322, -0.01546409446746111, 0.05169116333127022, -0.023678990080952644, -0.056036558002233505, -0.04937040060758591, -0.056763775646686554, 0.008399969898164272, 0.050442129373550415, 0.02941369079053402, -0.02044326439499855, 0.01...
b1fd230c-338c-4e6a-9f54-0a299e45b15e
slug: /use-cases/observability/clickstack/deployment/docker-compose title: 'Docker Compose' pagination_prev: null pagination_next: null sidebar_position: 3 description: 'Deploying ClickStack with Docker Compose - The ClickHouse Observability Stack' doc_type: 'guide' keywords: ['ClickStack Docker Compose', 'Docker Compo...
{"source_file": "docker-compose.md"}
[ 0.03079412505030632, -0.004682688508182764, 0.029327446594834328, -0.04333885759115219, -0.02047738805413246, -0.04597881808876991, 0.04022906720638275, -0.021787025034427643, -0.07796827703714371, 0.02186228707432747, 0.04396945610642433, -0.02981729805469513, 0.039587512612342834, 0.0297...
be87db76-a5d5-43d7-9896-d45476a48ed1
Complete connection details {#complete-connection-details} To connect to the deployed ClickHouse instance, simply click Create and accept the default settings. If you prefer to connect to your own external ClickHouse cluster e.g. ClickHouse Cloud, you can manually enter your connection credentials. If promp...
{"source_file": "docker-compose.md"}
[ 0.0755774974822998, -0.06948704272508621, 0.018628418445587158, 0.01163617242127657, -0.07617224752902985, -0.001013049273751676, -0.05048529431223869, -0.05800360441207886, -0.05045861750841141, 0.03976492956280708, 0.017962023615837097, -0.08991876244544983, 0.06270624697208405, -0.03264...
d7647b16-c506-4e0a-879f-bf18f8c84770
shell otel-collector: image: ${OTEL_COLLECTOR_IMAGE_NAME}:${IMAGE_VERSION} environment: CLICKHOUSE_ENDPOINT: '<CLICKHOUSE_ENDPOINT>' # https endpoint here CLICKHOUSE_USER: '<CLICKHOUSE_USER>' CLICKHOUSE_PASSWORD: '<CLICKHOUSE_PASSWORD>' HYPERDX_OTEL_EXPORTER_CLICKHOUSE_DATABASE: ${HYPERD...
{"source_file": "docker-compose.md"}
[ 0.060632988810539246, 0.012292861938476562, 0.008136485703289509, -0.0774930864572525, -0.028163287788629532, -0.1231537014245987, 0.0033994209952652454, -0.04761328548192978, 0.0011506355367600918, 0.033095479011535645, 0.08674021810293198, -0.08325812220573425, -0.015272866934537888, 0.0...
fe03b643-de7a-4358-82fa-e078717e61bc
slug: /use-cases/observability/clickstack/deployment/local-mode-only title: 'Local Mode Only' pagination_prev: null pagination_next: null sidebar_position: 5 description: 'Deploying ClickStack with Local Mode Only - The ClickHouse Observability Stack' doc_type: 'guide' keywords: ['clickstack', 'deployment', 'setup', 'c...
{"source_file": "local-mode-only.md"}
[ 0.019770927727222443, 0.010387533344328403, 0.013147804886102676, -0.04232202470302582, -0.0026876982301473618, -0.031725186854600906, 0.02634940668940544, -0.022863134741783142, -0.12396159023046494, 0.047768495976924896, 0.0703388899564743, 0.003725208807736635, 0.038602206856012344, 0.0...
ab308074-38ae-4abc-925f-bc0fda8b3165
slug: /use-cases/observability/clickstack/deployment/hyperdx-clickhouse-cloud title: 'ClickHouse Cloud' pagination_prev: null pagination_next: null sidebar_position: 1 description: 'Deploying ClickStack with ClickHouse Cloud' doc_type: 'guide' keywords: ['clickstack', 'deployment', 'setup', 'configuration', 'observabil...
{"source_file": "hyperdx-clickhouse-cloud.md"}
[ 0.019373049959540367, 0.004745457787066698, 0.020932896062731743, -0.03970642015337944, -0.0038765063509345055, 0.030321024358272552, 0.056712277233600616, -0.05174006149172783, -0.04975076764822006, 0.0720750167965889, 0.07653960585594177, 0.0022352745290845633, 0.07059668749570847, -0.02...
d496b4bc-87e5-4141-bc14-988aa3b9a319
You operate a large observability deployment and need the dedicated performance and scalability of ClickStack with ClickHouse Cloud. You're already using ClickHouse Cloud for analytics and want to instrument your application using ClickStack instrumentation libraries — sending data to the same cluster. In this case, ...
{"source_file": "hyperdx-clickhouse-cloud.md"}
[ 0.020271379500627518, -0.04979093000292778, -0.03501148149371147, -0.030957583338022232, -0.0714326873421669, -0.04061247780919075, 0.031179072335362434, -0.05462798848748207, -0.045172132551670074, 0.043298423290252686, -0.003906899597495794, -0.06198790669441223, 0.052952367812395096, -0...
c311eae1-2136-4d96-a6fb-1a7934ebbfce
```yaml file=docs/use-cases/observability/clickstack/deployment/_snippets/otel-cloud-config.yaml receivers: otlp/hyperdx: protocols: grpc: include_metadata: true endpoint: '0.0.0.0:4317' http: cors: allowed_origins: ['*'] allowed_headers: ['*'] inclu...
{"source_file": "hyperdx-clickhouse-cloud.md"}
[ 0.007142273709177971, 0.0006448182393796742, 0.023557497188448906, -0.04592304304242134, -0.013125668279826641, -0.12058790773153305, 0.052524395287036896, -0.056029658764600754, -0.025002753362059593, 0.045645225793123245, 0.11051959544420242, -0.02129243314266205, 0.029941610991954803, -...
101b6bb4-7373-49f9-aba4-212747ece157
IsMatch(log.cache["0"], "(?i)(trace)") - set(log.severity_text, "trace") where log.severity_number == SEVERITY_NUMBER_TRACE # Infer: else - set(log.severity_text, "info") where log.severity_number == 0 - set(log.severity_number, SEVERITY_NUMBER_INFO) where log.severit...
{"source_file": "hyperdx-clickhouse-cloud.md"}
[ 0.08658992499113083, 0.08210182189941406, -0.047851383686065674, 0.061450254172086716, 0.04589821770787239, -0.12591543793678284, 0.03895993530750275, 0.057791970670223236, -0.043024297803640366, 0.007143013179302216, -0.01354168076068163, -0.0250955019146204, 0.033286623656749725, 0.02335...
d6304b7b-23ba-4415-8b12-d376abcebffa
``` Deploy the collector using the following Docker command, setting the respective environment variables to the connection settings recorded earlier and using the appropriate command below based on your operating system. ```bash modify to your cloud endpoint export CLICKHOUSE_ENDPOINT= export CLICKHOUSE_PASS...
{"source_file": "hyperdx-clickhouse-cloud.md"}
[ 0.011935022659599781, -0.001142472610808909, -0.04147610440850258, -0.014745275489985943, -0.08062495291233063, -0.09212879091501236, 0.010530179366469383, -0.07533211261034012, 0.030456742271780968, 0.04107845947146416, 0.03766518458724022, -0.13509143888950348, 0.017321964725852013, -0.0...
51a38a3a-bb98-4f78-8efa-d34b21c49ac5
Create a data source {#create-a-datasource} HyperDX is Open Telemetry native but not Open Telemetry exclusive - users can use their own table schemas if desired. Using Open Telemetry schemas {#using-otel-schemas} If you're using the above OTel collector to create the database and tables within ClickHouse, retain...
{"source_file": "hyperdx-clickhouse-cloud.md"}
[ 0.012876790948212147, -0.12613412737846375, -0.024726271629333496, -0.010987231507897377, -0.08322872966527939, -0.07538869231939316, 0.07067427039146423, -0.0411955788731575, -0.017161410301923752, 0.04145454987883568, 0.031710803508758545, -0.10147731006145477, 0.04733709245920181, -0.02...
1f5f47cd-bcfd-4c87-afec-75b2571afe71
slug: /use-cases/observability/clickstack/migration title: 'Migrating to ClickStack from other Observability solutions' pagination_prev: null pagination_next: null sidebar_label: 'Migration guides' description: 'Migrating to ClickStack from other Observability solutions' doc_type: 'guide' keywords: ['migrate to ClickSt...
{"source_file": "index.md"}
[ 0.011425835080444813, -0.0782892033457756, -0.0286650862544775, -0.01200953871011734, 0.05292250216007233, -0.029106194153428078, -0.007552334573119879, -0.003495382145047188, -0.10646480321884155, 0.053745973855257034, 0.010765057057142258, -0.03107272833585739, 0.028943490236997604, -0.0...
a72e59c3-3c42-4c94-b794-8547ca9fe77f
slug: /use-cases/observability/clickstack/sdks/golang pagination_prev: null pagination_next: null sidebar_position: 2 description: 'Golang SDK for ClickStack - The ClickHouse Observability Stack' title: 'Golang' doc_type: 'guide' keywords: ['Golang ClickStack SDK', 'Go OpenTelemetry integration', 'Golang observability'...
{"source_file": "golang.md"}
[ 0.017676739022135735, -0.02108115144073963, -0.02657933533191681, -0.051786910742521286, -0.08859284967184067, -0.07508005201816559, 0.06357565522193909, 0.016986258327960968, -0.062026262283325195, -0.037258926779031754, 0.07829712331295013, -0.04558548331260681, -0.016696035861968994, 0....
023e16cd-2fda-4411-8c5f-749e341d16a0
ctx := context.Background() // configure opentelemetry logger provider logExporter, _ := otlplogs.NewExporter(ctx) loggerProvider := sdk.NewLoggerProvider( sdk.WithBatcher(logExporter), ) // gracefully shutdown logger to flush accumulated signals before program finish defer loggerProvider.Shutdown(ctx) ...
{"source_file": "golang.md"}
[ -0.007852206006646156, 0.0804213285446167, -0.043755292892456055, 0.0033847761806100607, -0.005750715732574463, -0.13615597784519196, 0.053516339510679245, -0.04793572425842285, 0.012776791118085384, 0.046856559813022614, -0.02418345957994461, 0.01483539305627346, 0.06320489197969437, 0.05...
62607040-8718-40d3-b0ef-e49a0c9854fa
defer otelShutdown() ctx := context.Background() // configure opentelemetry logger provider logExporter, _ := otlplogs.NewExporter(ctx) loggerProvider := sdk.NewLoggerProvider( sdk.WithBatcher(logExporter), ) // gracefully shutdown logger to flush accumulated signals before program finish defer logger...
{"source_file": "golang.md"}
[ -0.032490964978933334, 0.05016345530748367, -0.023346450179815292, -0.02405618503689766, -0.021127821877598763, -0.11486342549324036, 0.009614473208785057, -0.002976481569930911, 0.004657383542507887, 0.056298449635505676, -0.03158269450068474, 0.03212926164269447, 0.013350270688533783, 0....
28e79886-8fda-4d53-908e-82ec711c0af2
slug: /use-cases/observability/clickstack/sdks/react-native pagination_prev: null pagination_next: null sidebar_position: 7 description: 'React Native SDK for ClickStack - The ClickHouse Observability Stack' title: 'React Native' doc_type: 'guide' keywords: ['clickstack', 'sdk', 'logging', 'integration', 'application m...
{"source_file": "react-native.md"}
[ -0.00921218004077673, -0.035914260894060135, 0.07505617290735245, -0.026282358914613724, 0.010721614584326744, -0.002605793531984091, -0.02066861279308796, 0.04177502170205116, -0.05304582417011261, -0.0028630064334720373, -0.029669510200619698, -0.03580746054649353, -0.016592836007475853, ...
41593185-5550-4f16-8b0e-8a0472848f53
View navigation {#view-navigation} react-navigation version 5 and 6 are supported. The following example shows how to instrument navigation: ```javascript import { startNavigationTracking } from '@hyperdx/otel-react-native'; export default function App() { const navigationRef = useNavigationContainerRef(); ...
{"source_file": "react-native.md"}
[ 0.04499909281730652, -0.057478342205286026, 0.04521382972598076, -0.07170815020799637, -0.014644422568380833, 0.013880020938813686, -0.07044122368097305, -0.0033982908353209496, -0.0899021103978157, 0.06333575397729874, -0.057726435363292694, -0.009333327412605286, -0.029479065909981728, 0...
e3d4b299-4eb9-4008-8991-f48822ce7f59
slug: /use-cases/observability/clickstack/sdks/python pagination_prev: null pagination_next: null sidebar_position: 7 description: 'Python for ClickStack - The ClickHouse Observability Stack' title: 'Python' doc_type: 'guide' keywords: ['clickstack', 'sdk', 'logging', 'integration', 'application monitoring'] import...
{"source_file": "python.md"}
[ -0.02116786502301693, -0.045528609305620193, -0.034783441573381424, -0.013336931355297565, -0.054023850709199905, -0.1122107207775116, 0.0773378312587738, 0.02083105407655239, -0.07606600970029831, 0.012806792743504047, 0.04865891858935356, -0.021632982417941093, 0.027908578515052795, -0.0...
8a8c0d57-d61b-4958-9941-63bef4d4f601
Advanced configuration {#advanced-configuration} Network capture {#network-capture} By enabling network capture features, developers gain the capability to debug HTTP request headers and body payloads effectively. This can be accomplished simply by setting HYPERDX_ENABLE_ADVANCED_NETWORK_CAPTURE flag to 1. shel...
{"source_file": "python.md"}
[ 0.06707172840833664, 0.05978631600737572, 0.03971302509307861, 0.04765433073043823, 0.05326742306351662, -0.12137748301029205, -0.021539118140935898, -0.013918437995016575, -0.04942135140299797, 0.00993932131677866, -0.014219381846487522, -0.05195872485637665, 0.026080012321472168, -0.0019...
1f0d800b-78d4-43cc-b868-37598bf9df89
slug: /use-cases/observability/clickstack/sdks/browser pagination_prev: null pagination_next: null sidebar_position: 0 description: 'Browser SDK for ClickStack - The ClickHouse Observability Stack' title: 'Browser JS' doc_type: 'guide' keywords: ['ClickStack', 'browser-sdk', 'javascript', 'session-replay', 'frontend'] ...
{"source_file": "browser.md"}
[ -0.039029259234666824, -0.039844490587711334, -0.031122170388698578, -0.047975607216358185, 0.03002212382853031, -0.013670296408236027, 0.062000252306461334, 0.03363548219203949, -0.031699713319540024, -0.03749542310833931, -0.02550441026687622, -0.0146287577226758, 0.016531797125935555, -...
b0868a81-146d-4d23-a1cd-37fc17a77be4
disableIntercom - (Optional) Whether to disable Intercom integration (default false ) disableReplay - (Optional) Whether to disable session replay (default false ) Additional configuration {#additional-configuration} Attach user information or metadata {#attach-user-information-or-metadata} Attaching user...
{"source_file": "browser.md"}
[ 0.003552383976057172, 0.10118510574102402, 0.05247633904218674, 0.0014210161752998829, -0.036596644669771194, 0.03920511156320572, 0.09760601073503494, -0.01847800426185131, 0.00014907887089066207, -0.036025360226631165, -0.07273852080106735, -0.03949461132287979, -0.04425130784511566, 0.0...
6472ea2c-ed12-44db-93ae-3dd92eef115f
```javascript var cors = require('cors'); var onHeaders = require('on-headers'); // ... all your stuff app.use(function (req, res, next) { onHeaders(res, function () { var allowOrigin = res.getHeader('Access-Control-Allow-Origin'); if (allowOrigin) { res.setHeader('Timing-Allow-Origin', allowOrigin)...
{"source_file": "browser.md"}
[ -0.04895583540201187, 0.07361187040805817, -0.06864172220230103, -0.08482292294502258, 0.023570287972688675, -0.04372589290142059, -0.08012933284044266, -0.01625612936913967, 0.03426050394773483, -0.03514597564935684, 0.03394099324941635, -0.013949645683169365, -0.057085923850536346, -0.00...
197825cd-3fc6-4f3b-b1ea-48832536d98d
slug: /use-cases/observability/clickstack/sdks/elixir pagination_prev: null pagination_next: null sidebar_position: 1 description: 'Elixir SDK for ClickStack - The ClickHouse Observability Stack' title: 'Elixir' doc_type: 'guide' keywords: ['Elixir ClickStack SDK', 'Elixir observability', 'HyperDX Elixir', 'Elixir logg...
{"source_file": "elixir.md"}
[ -0.019533377140760422, -0.06449215859174728, 0.0059045953676104546, -0.03642934933304787, -0.051933661103248596, -0.13014541566371918, 0.033563032746315, -0.01541233342140913, -0.10812515020370483, 0.0003556427836883813, 0.06326231360435486, -0.08721771836280823, 0.059079915285110474, -0.0...
c392115e-cd4b-461d-b251-99a6af0f8279
slug: /use-cases/observability/clickstack/sdks/nextjs pagination_prev: null pagination_next: null sidebar_position: 4 description: 'Next.js SDK for ClickStack - The ClickHouse Observability Stack' title: 'Next.js' doc_type: 'guide' keywords: ['clickstack', 'sdk', 'logging', 'integration', 'application monitoring'] ...
{"source_file": "nextjs.md"}
[ -0.038015954196453094, -0.05023328214883804, -0.008151200599968433, -0.07341443002223969, 0.024596599861979485, -0.005723652429878712, -0.016310881823301315, -0.025636348873376846, 0.00201935856603086, 0.02046528458595276, 0.03588035702705383, 0.017979241907596588, -0.010514519177377224, -...
04cd2e6e-841c-4d3d-908f-2058e78edc94
slug: /use-cases/observability/clickstack/sdks/deno pagination_prev: null pagination_next: null sidebar_position: 6 description: 'Deno SDK for ClickStack - The ClickHouse Observability Stack' title: 'Deno' doc_type: 'guide' keywords: ['Deno ClickStack SDK', 'Deno OpenTelemetry', 'ClickStack Deno integration', 'Deno obs...
{"source_file": "deno.md"}
[ -0.029752112925052643, -0.020016446709632874, 0.005084160249680281, 0.019760027527809143, -0.020412638783454895, -0.09434331953525543, 0.01830495521426201, 0.014610431157052517, -0.07739676535129547, 0.07483112066984177, 0.0007290650974027812, -0.02300964668393135, -0.04372098669409752, 0....
558c9819-72fb-43a6-a0fd-b8c227d1938d
slug: /use-cases/observability/clickstack/sdks pagination_prev: null pagination_next: null description: 'Language SDKs for ClickStack - The ClickHouse Observability Stack' title: 'Language SDKs' doc_type: 'guide' keywords: ['ClickStack SDKs', 'ClickStack language SDKs', 'OpenTelemetry SDKs ClickStack', 'application ins...
{"source_file": "index.md"}
[ -0.04973476380109787, -0.035790473222732544, -0.08076104521751404, -0.0311770960688591, 0.01424381323158741, -0.07299365103244781, 0.11389061063528061, 0.016476687043905258, 0.04064825922250748, -0.020071618258953094, 0.02949763648211956, -0.043971702456474304, 0.01211012527346611, -0.0315...
d2358de0-e825-49ce-a9e8-42b332264e5b
shell OTEL_EXPORTER_OTLP_HEADERS='authorization=<YOUR_INGESTION_API_KEY>' This API key is generated by the HyperDX application, and is available via the app in Team Settings → API Keys . For most language SDKs and telemetry libraries that support OpenTelemetry, you can simply set OTEL_EXPORTER_OTLP_ENDPOINT en...
{"source_file": "index.md"}
[ 0.07010360062122345, 0.02222316898405552, 0.007358059287071228, -0.03339606150984764, -0.040073174983263016, -0.05995917320251465, 0.03799077495932579, -0.012853746302425861, 0.05861043930053711, 0.023752527311444283, -0.045240893959999084, -0.11176919937133789, 0.016465166583657265, -0.03...
1d264fdc-a8af-4d2e-b3e2-117913bf08b4
slug: /use-cases/observability/clickstack/sdks/aws_lambda pagination_prev: null pagination_next: null sidebar_position: 6 description: 'AWS Lambda for ClickStack - The ClickHouse Observability Stack' title: 'AWS Lambda' doc_type: 'guide' keywords: ['ClickStack', 'observability', 'aws-lambda', 'lambda-layers'] impor...
{"source_file": "aws-lambda.md"}
[ -0.03378814086318016, -0.023174164816737175, -0.05319739133119583, 0.019988173618912697, -0.02124348282814026, -0.01346160564571619, 0.07021546363830566, -0.02849506214261055, -0.0065880208276212215, 0.04483519867062569, 0.03597472608089447, -0.05242890864610672, 0.03917069360613823, -0.01...
f6325305-885b-40a6-b2de-7f77fa673af4
To install the collector layer : In the Layers section click "Add a layer" Select specify an ARN and choose the correct ARN based on architecture, ensure you replace the <region> with your region (ex. us-east-2 ): shell arn:aws:lambda:<region>:184161586896:layer:opentelemetry-collector-amd64-0_8_0:1 ...
{"source_file": "aws-lambda.md"}
[ -0.06765014678239822, -0.02658626064658165, -0.06438367068767548, 0.000328983849612996, -0.05083979666233063, -0.055245619267225266, -0.007799368817359209, -0.07705769687891006, 0.026389198377728462, 0.06296112388372421, 0.022466741502285004, -0.12737493216991425, -0.06818421930074692, -0....
a8ff1fb8-8410-41e9-b3c3-4f2c86ed0492
exporters: logging: verbosity: detailed otlphttp: endpoint: "https://in-otel.hyperdx.io" headers: authorization: compression: gzip service: telemetry: logs: level: "debug" pipelines: traces: receivers: [otlp] processors: [batch, decouple] exporters: [otl...
{"source_file": "aws-lambda.md"}
[ -0.019013330340385437, -0.008599977940320969, -0.006968293339014053, -0.010152621194720268, 0.01728459820151329, -0.0799654871225357, 0.03356385976076126, -0.025227990001440048, -0.02853233925998211, 0.016514835879206657, 0.008918458595871925, -0.0032891470473259687, -0.03996695950627327, ...
96bed019-7818-47f2-ba0d-dfe6972c1812
slug: /use-cases/observability/clickstack/sdks/java pagination_prev: null pagination_next: null sidebar_position: 3 description: 'Java SDK for ClickStack - The ClickHouse Observability Stack' title: 'Java' doc_type: 'guide' keywords: ['Java SDK ClickStack', 'Java OpenTelemetry ClickStack', 'Java observability SDK', 'Cl...
{"source_file": "java.md"}
[ -0.05946516618132591, -0.02822370082139969, -0.037314847111701965, -0.05694884806871414, -0.0134347602725029, -0.08862514793872833, 0.0539293996989727, 0.038092225790023804, -0.036488186568021774, -0.01931951381266117, 0.044767118990421295, -0.03535290062427521, 0.02183433435857296, -0.023...
a61cd894-e492-4feb-830e-010418611ce5
slug: /use-cases/observability/clickstack/sdks/ruby-on-rails pagination_prev: null pagination_next: null sidebar_position: 7 description: 'Ruby on Rails SDK for ClickStack - The ClickHouse Observability Stack' title: 'Ruby on Rails' doc_type: 'guide' keywords: ['clickstack', 'sdk', 'logging', 'integration', 'applicatio...
{"source_file": "ruby.md"}
[ -0.0012945544440299273, -0.08495242148637772, -0.05123339965939522, 0.031751230359077454, 0.009874224662780762, -0.04755362495779991, 0.036880962550640106, 0.006839429493993521, -0.08219128102064133, 0.050478626042604446, 0.02888306975364685, -0.004547407850623131, 0.005932297557592392, -0...
51436a22-be85-47eb-8898-ac494773d862
slug: /use-cases/observability/clickstack/sdks/nestjs pagination_prev: null pagination_next: null sidebar_position: 4 description: 'NestJS SDK for ClickStack - The ClickHouse Observability Stack' title: 'NestJS' doc_type: 'guide' keywords: ['clickstack', 'sdk', 'logging', 'integration', 'application monitoring'] Th...
{"source_file": "nestjs.md"}
[ -0.013762310147285461, -0.006878492888063192, -0.02219872549176216, -0.012736305594444275, -0.06059511378407478, -0.044237829744815826, 0.024021657183766365, 0.0057601844891905785, -0.03892955556511879, 0.05308149382472038, -0.009788875468075275, -0.021154461428523064, 0.00001559063821332529...
f3d22d76-2e4f-4ce8-a056-36b595250ee8
Change your main module to provide the Logger service: ```javascript import { Logger, Module } from '@nestjs/common'; @Module({ providers: [Logger], }) export class AppModule {} ``` Then inject the logger simply by type hinting it with the Logger from @nestjs/common : ```javascript import { Controller, Logge...
{"source_file": "nestjs.md"}
[ -0.006431586109101772, 0.0026609147898852825, 0.030396584421396255, 0.020383136346936226, 0.024937361478805542, -0.05209878459572792, 0.016370538622140884, 0.03648914769291878, 0.016058769077062607, 0.03535366803407669, 0.023798948153853416, -0.013614415191113949, -0.027568664401769638, 0....
57d62472-88bc-4ce1-b5c0-a01d4132796a
slug: /use-cases/observability/clickstack/sdks/nodejs pagination_prev: null pagination_next: null sidebar_position: 5 description: 'Node.js SDK for ClickStack - The ClickHouse Observability Stack' title: 'Node.js' doc_type: 'guide' keywords: ['clickstack', 'sdk', 'logging', 'integration', 'application monitoring'] ...
{"source_file": "nodejs.md"}
[ 0.0069094011560082436, -0.010275899432599545, -0.0029429015703499317, -0.011454404331743717, -0.01174128521233797, -0.060257721692323685, 0.03126371279358864, 0.022596444934606552, -0.0401155985891819, 0.0411510244011879, 0.024988461285829544, -0.0024592308327555656, -0.005441084038466215, ...
f5bd2652-144c-4ab5-b417-c85c98494939
export default logger; ``` By default, console.* methods are supported out of the box. No additional configuration is required. You can disable this by setting the HDX_NODE_CONSOLE_CAPTURE environment variable to 0 or by passing consoleCapture: false to the init function. Setup error collection {#...
{"source_file": "nodejs.md"}
[ 0.029962880536913872, 0.019133765250444412, 0.04474303871393204, -0.013050109148025513, 0.039278294891119, -0.00411595031619072, -0.009664046578109264, 0.03998660296201706, -0.09082105755805969, 0.04144052788615227, -0.037333983927965164, -0.04847533255815506, 0.02835969254374504, -0.02769...
4b97d983-5f4d-4687-a655-eeec6581285e
This is a convenient way to ensure all logs/spans are automatically tagged with the right identifiers to be searched on later, instead of needing to manually tag and propagate identifiers yourself. userId , userEmail , userName , and teamName will populate the sessions UI with the corresponding values, but can be...
{"source_file": "nodejs.md"}
[ 0.015156755223870277, 0.02876594290137291, 0.046173181384801865, 0.0064351726323366165, -0.006069296970963478, -0.010211270302534103, 0.09598958492279053, -0.04376445710659027, -0.03529629856348038, 0.0037037183064967394, -0.05413902923464775, -0.029982497915625572, 0.004678286612033844, -...
ee41f4ad-1b40-43cd-9dca-dc2b3d3ce5ab
initSDK({ consoleCapture: true, // optional, default: true additionalInstrumentations: [], // optional, default: [] }); ``` The OTEL_SERVICE_NAME environment variable is used to identify your service in the HyperDX app, it can be any name you want. Enabling exception capturing {#enabling-exception-cap...
{"source_file": "nodejs.md"}
[ -0.0074181463569402695, 0.05650261789560318, 0.027087874710559845, -0.034400083124637604, 0.003693929174914956, -0.0022993239108473063, -0.01604621671140194, 0.026524825021624565, -0.04029491916298866, 0.0374005027115345, -0.05867000296711922, -0.10194536298513412, 0.09716884046792984, -0....
c8173382-aa7c-417f-ac52-d20106b42f65
slug: /use-cases/observability/clickstack/migration/elastic/search title: 'Searching in ClickStack and Elastic' pagination_prev: null pagination_next: null sidebar_label: 'Search' sidebar_position: 3 description: 'Searching in ClickStack and Elastic' doc_type: 'guide' keywords: ['clickstack', 'search', 'logs', 'observa...
{"source_file": "search.md"}
[ 0.02304530143737793, 0.006900451611727476, -0.04025052860379219, 0.021078037098050117, -0.0027689894195646048, -0.04563738405704498, 0.03250405192375183, -0.0013153032632544637, -0.04641474038362503, 0.06136021763086319, 0.022845296189188957, 0.012349451892077923, 0.08595357090234756, -0.0...
c2e85db8-75a6-4df9-b564-b0d102bc87b4
| Feature | HyperDX Syntax | Elasticsearch Syntax | Comments | |-------------------------|----------------------------------------|----------------------------------------|--------------| | Free text search | error | error | Matches across all indexed fields; in ClickStack this is rewritten to a mult...
{"source_file": "search.md"}
[ -0.010259905830025673, 0.0139244943857193, 0.07330760359764099, 0.017810119315981865, 0.02128286100924015, -0.004865727853029966, 0.08604813367128372, 0.014543652534484863, -0.012861298397183418, 0.030787913128733635, 0.00919751450419426, -0.10172491520643234, 0.10619731992483139, -0.02450...
d6788c82-6702-4655-86c2-b3dd4b78f41a
editDistance('quikc', field) = 1 | quikc~ | Not currently supported in Lucene syntax. Distance functions can be used in SQL e.g. editDistance('rror', SeverityText) = 1 or other similarity functions . | | Proximity search | Not supported | "fox quick"~5 | Not currently supported in L...
{"source_file": "search.md"}
[ -0.010240538977086544, 0.006341262720525265, -0.0015683445381000638, -0.02462206408381462, -0.05028669163584709, 0.06068917363882065, -0.005126279778778553, 0.03464142978191376, -0.031462401151657104, -0.008973421528935432, 0.04153740778565407, -0.04021883010864258, 0.029192209243774414, 0...
868d4ca5-a9a7-45ee-ac4d-ac26c2a3af40
Exists/missing differences {#empty-value-differences} Unlike Elasticsearch, where a field can be entirely omitted from an event and therefore truly "not exist," ClickHouse requires all columns in a table schema to exist. If a field is not provided in an insert event: For Nullable fields, it will be set to NULL...
{"source_file": "search.md"}
[ 0.017065249383449554, -0.016904039308428764, -0.028270963579416275, 0.05061683803796768, 0.05699218064546585, -0.014875151216983795, -0.020749077200889587, -0.041244011372327805, 0.08388979732990265, 0.025248808786273003, 0.032615575939416885, -0.059753768146038055, 0.04845834895968437, -0...
2c1cc5ea-433c-4fe6-9997-4cf40c429da3
slug: /use-cases/observability/clickstack/migration/elastic/migrating-sdks title: 'Migrating SDKs from Elastic' pagination_prev: null pagination_next: null sidebar_label: 'Migrating SDKs' sidebar_position: 6 description: 'Migrating SDKs from Elastic' show_related_blogs: true keywords: ['ClickStack'] doc_type: 'guide' ...
{"source_file": "migrating-sdks.md"}
[ -0.010708955116569996, -0.0370822511613369, -0.05251934379339218, -0.059531137347221375, 0.06915874779224396, -0.06675224006175995, 0.0164490994066, 0.03161562606692314, 0.03293891251087189, 0.04588194191455841, 0.05273258686065674, -0.01760912872850895, 0.06630034744739532, -0.02014107443...
a63aac8f-9719-4182-8be1-e5ad8abac19b
To migrate to ClickStack, update the endpoint to point to the local OTLP Collector and change the authorization header: shell export OTEL_RESOURCE_ATTRIBUTES=service.name=<app-name> export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318 export OTEL_EXPORTER_OTLP_HEADERS="authorization=<YOUR_INGESTION_API_KEY>" Yo...
{"source_file": "migrating-sdks.md"}
[ -0.0027380697429180145, -0.07977432012557983, -0.010975455865263939, -0.09147685021162033, -0.008388321846723557, -0.039180368185043335, 0.06496638059616089, -0.029769986867904663, -0.07301269471645355, 0.02865998074412346, -0.001435613725334406, -0.08576545864343643, 0.018624164164066315, ...
7c43d565-1dbe-4059-8262-a8224980a41d
slug: /use-cases/observability/clickstack/migration/elastic/migrating-agents title: 'Migrating agents from Elastic' pagination_prev: null pagination_next: null sidebar_label: 'Migrating agents' sidebar_position: 5 description: 'Migrating agents from Elastic' show_related_blogs: true keywords: ['ClickStack'] doc_type: '...
{"source_file": "migrating-agents.md"}
[ 0.06817039847373962, 0.000019718718249350786, -0.03547857701778412, 0.0033705097157508135, 0.08785086870193481, -0.025534283369779587, 0.030160248279571533, 0.0015363652491942048, -0.02408745512366295, 0.08321225643157959, 0.06839605420827866, -0.017459914088249207, 0.0816812589764595, 0.0...
1cd0640f-86f2-4e2d-b56a-ded81ce10558
ClickHouse OpenTelemetry endpoint {#clickhouse-otel-endpoint} All data is ingested into ClickStack via an OpenTelemetry (OTel) collector instance, which acts as the primary entry point for logs, metrics, traces, and session data. We recommend using the official ClickStack distribution of the collector for this in...
{"source_file": "migrating-agents.md"}
[ -0.01854691281914711, -0.06088339909911156, -0.03159651532769203, 0.007194270379841328, -0.010498158633708954, -0.037557948380708694, 0.01051319483667612, -0.036339208483695984, 0.016844309866428375, 0.011416543275117874, 0.005229765083640814, -0.09455031156539917, 0.0009894692339003086, -...
c0e4686d-158c-4db3-9c8b-87552b91638a
Users can follow best practices with regards to architecture and security when moving Vector to production . Configure vector {#configure-vector} Vector should be configured to receive events over the Lumberjack protocol, imitating a Logstash instance. This can be achieved by configuring a logstash source for V...
{"source_file": "migrating-agents.md"}
[ 0.011762324720621109, 0.0794731006026268, -0.0071966093964874744, -0.00651378370821476, 0.011874040588736534, -0.06379247456789017, -0.027538590133190155, -0.05855359509587288, 0.03464764729142189, 0.0988166406750679, -0.0389513224363327, -0.05024820193648338, 0.011570802889764309, 0.01965...
5d399468-ae38-43a4-9ade-4c016dc95869
# Flatten both objects separately flattened_resources = flatten(resource_obj, separator: ".") flattened_logs = flatten(log_record_obj, separator: ".") # Process resource attributes resource_attributes = [] resource_keys_list = keys(flattened_resources) for_each(resource_keys_list) -> |_index, field_key| { field_va...
{"source_file": "migrating-agents.md"}
[ -0.010436014272272587, 0.09213094413280487, 0.022964412346482277, 0.03025314025580883, 0.01590939238667488, -0.09342943876981735, 0.07457209378480911, 0.05071938410401344, -0.019467655569314957, -0.01988295279443264, -0.0005583315505646169, -0.02445734106004238, 0.013088500127196312, 0.033...
3c97a3e9-a8a4-4245-9569-7f201e2ff7c6
yaml sinks: otlp: type: opentelemetry inputs: [remap_filebeat] # receives events from a remap transform - see below protocol: type: http # Use "grpc" for port 4317 uri: http://localhost:4318/v1/logs # logs endpoint for the OTel collector method: post encoding: codec: json...
{"source_file": "migrating-agents.md"}
[ 0.02018706128001213, 0.020962709560990334, 0.00008814977627480403, -0.04745429381728172, -0.07915766537189484, -0.040018923580646515, -0.028350448235869408, -0.06834261864423752, 0.05750023201107979, 0.02870333380997181, 0.005841957405209541, -0.0749196708202362, -0.017886614426970482, -0....
9992852a-d496-4a93-a12b-7b045635ae6d
Run the agent as Elastic OpenTelemetry Collector (EDOT) . The Elastic Agent includes an embedded EDOT Collector that allows you to instrument your applications and infrastructure once and send data to multiple vendors and backends. In this configuration, users can simply configure the EDOT collector to forward events t...
{"source_file": "migrating-agents.md"}
[ -0.023659147322177887, -0.028964774683117867, -0.027412381023168564, -0.008569145575165749, -0.014811479486525059, -0.06525130569934845, 0.007667114958167076, -0.025934429839253426, -0.005207802169024944, 0.0813034400343895, -0.038894880563020706, -0.0645827129483223, 0.015772107988595963, ...
eaf780f8-b175-4532-a732-a58e5346534c
yaml exporters: # Exporter to send logs and metrics to Elasticsearch Managed OTLP Input otlp: endpoint: localhost:4317 headers: authorization: ${YOUR_INGESTION_API_KEY} tls: insecure: true The YOUR_INGESTION_API_KEY here is produced by ClickStack. You can find the key in the HyperDX app ...
{"source_file": "migrating-agents.md"}
[ 0.03153056278824806, 0.03312236815690994, -0.0036052376963198185, -0.003645320190116763, -0.03540455549955368, -0.07354141771793365, -0.022998955100774765, -0.03996472433209419, 0.06375294923782349, 0.05324813351035118, -0.04205596446990967, -0.09147127717733383, 0.026690542697906494, 0.05...
e2e49f29-e2af-4fde-be36-9e0b6d4bdc2a
slug: /use-cases/observability/clickstack/migration/elastic/concepts title: 'Equivalent concepts in ClickStack and Elastic' pagination_prev: null pagination_next: null sidebar_label: 'Equivalent concepts' sidebar_position: 1 description: 'Equivalent concepts - ClickStack and Elastic' show_related_blogs: true keywords: ...
{"source_file": "concepts.md"}
[ 0.05857968330383301, 0.04879562929272652, -0.017053525894880295, -0.006154338363558054, 0.04397694393992424, -0.00854707695543766, -0.011006222106516361, 0.007641966454684734, -0.03702395781874657, 0.044856999069452286, 0.00868531595915556, -0.011097375303506851, 0.0763736367225647, 0.0163...
f1917dbe-6383-489c-b44e-0d8c75b8e836
Data Collection and ETL : agents and pipelines that gather telemetry data and process it before ingestion. The table below outlines how each stack maps its components to these roles: | Role | Elastic Stack | ClickStack | Comments | |--------------------------|----------------------------------------------...
{"source_file": "concepts.md"}
[ -0.00766970356926322, -0.017839333042502403, -0.008008417673408985, 0.023090282455086708, -0.016519280150532722, -0.06328161060810089, 0.05911936238408089, -0.002197032095864415, 0.03714235872030258, 0.027544287964701653, 0.02307138778269291, -0.035532549023628235, 0.03797316551208496, -0....
e9c5ac64-d250-4aad-8041-ef451a40fc87
Elasticsearch vs ClickHouse {#elasticsearch-vs-clickhouse} ClickHouse and Elasticsearch organize and query data using different underlying models, but many core concepts serve similar purposes. This section outlines key equivalences for users familiar with Elastic, mapping them to their ClickHouse counterparts. While...
{"source_file": "concepts.md"}
[ 0.020168794319033623, -0.013960698619484901, -0.05341288819909096, 0.03345179930329323, 0.0069202701561152935, -0.061613839119672775, -0.00026466266717761755, -0.0028674877248704433, 0.02456512674689293, 0.01688808761537075, -0.04857692867517471, -0.005614245310425758, 0.038747068494558334, ...
07c7d18a-037d-4ccb-a2fe-669b73aaa3ec
ClickHouse's approach to type flexibility is more transparent and controlled. Unlike Elasticsearch, where type conflicts can cause ingestion errors, ClickHouse allows mixed-type data in Variant columns and supports schema evolution through the use of the JSON type. If not using JSON , the schema is statically-de...
{"source_file": "concepts.md"}
[ -0.0068983882665634155, 0.023877214640378952, -0.019433865323662758, 0.04832267761230469, -0.0027305278927087784, -0.03882487490773201, -0.014514368958771229, -0.001949321129359305, 0.027735257521271706, -0.006827124394476414, -0.033277399837970734, -0.01659345254302025, -0.00381704326719045...
fbe26fc2-2012-4d2a-8ffc-dc0432602427
Indexing and storage {#indexing-and-storage} The concept of sharding is fundamental to Elasticsearch's scalability model. Each ① index is broken into shards , each of which is a physical Lucene index stored as segments on disk. A shard can have one or more physical copies called replica shards for resilience. Fo...
{"source_file": "concepts.md"}
[ 0.035627152770757675, 0.027976019307971, 0.010389639995992184, 0.03873123601078987, -0.01374963391572237, -0.041627172380685806, -0.06973917782306671, 0.006278686691075563, 0.08047255873680115, 0.007736987434327602, -0.03669913858175278, 0.09216535091400146, 0.03252973407506943, -0.0143200...
3d58eda0-dfe3-44ec-92da-23a5be8f8325
ClickHouse also supports skip indexes , which accelerate filtering by precomputing index data for selected columns. These must be explicitly defined but can significantly improve performance. Additionally, ClickHouse lets users specify compression codecs and compression algorithms per column — something Elasticsearc...
{"source_file": "concepts.md"}
[ 0.027328258380293846, -0.010632316581904888, -0.02722688391804695, -0.005555411800742149, 0.01631813496351242, -0.060045525431632996, -0.08132491260766983, -0.04791262373328209, 0.04019470885396004, 0.024691123515367508, -0.02558015286922455, 0.06393342465162277, 0.04538927227258682, -0.01...
00bcaa6d-5810-405f-8f68-55d2f6b3984d
Conversely, ClickHouse employs eventual consistency by default, coordinated by Keeper - a lightweight alternative to ZooKeeper. Writes can be sent to any replica directly or via a distributed table , which automatically selects a replica. Replication is asynchronous - changes are propagated to other replicas after...
{"source_file": "concepts.md"}
[ -0.026870915666222572, -0.07238588482141495, 0.0026740930043160915, 0.04149554297327995, -0.03268430754542351, -0.06369902938604355, -0.06132613122463226, -0.07500778883695602, 0.05594022572040558, 0.08213493973016739, -0.010582965798676014, 0.04852258786559105, 0.047147564589977264, -0.03...
7d2ddf7f-7cb5-4974-9865-35d20f90037d
While both systems support the aggregation of data, ClickHouse offers significantly more functions , including statistical, approximate, and specialized analytical functions. In observability use cases, one of the most common applications for aggregations is to count how often specific log messages or events occur (...
{"source_file": "concepts.md"}
[ 0.046190910041332245, -0.030139904469251633, 0.010205908678472042, 0.07246363908052444, -0.0036252059508115053, -0.04519353806972504, -0.03954620659351349, 0.015281864441931248, 0.12672600150108337, 0.015618848614394665, -0.03933960199356079, 0.008326728828251362, 0.06856939196586609, -0.0...
88621f00-044b-41c1-8cfd-ce090e9d4944
Query execution is further parallelized by: 1. SIMD vectorization : operations on columnar data use CPU SIMD instructions (e.g., AVX512 ), allowing batch processing of values. 2. Cluster-level parallelism : in distributed setups, each node performs query processing locally. Partial aggregation states are streame...
{"source_file": "concepts.md"}
[ 0.0195953156799078, 0.005641143303364515, -0.010738339275121689, 0.04108646139502525, 0.010553169064223766, -0.049638763070106506, -0.04749194160103798, -0.02086162567138672, 0.07752788811922073, 0.010838408023118973, -0.04736361280083656, 0.026363162323832512, 0.03480853512883186, -0.0669...
b6603776-9424-4ee8-bb39-c8da19c6e270
ClickHouse takes a different approach. Data is typically stored in a single table and managed using TTL (time-to-live) expressions at the column or partition level. Data can be partitioned by date , allowing efficient deletion without the need to create new tables or perform index rollovers. As data ages and meets...
{"source_file": "concepts.md"}
[ -0.006404290907084942, -0.014596069231629372, -0.00017474955529905856, 0.05240395665168762, 0.012808240950107574, -0.05452004820108414, -0.080356664955616, -0.07564651221036911, 0.05942181870341301, 0.07403983920812607, 0.005308432970196009, 0.06169355288147926, 0.057302169501781464, -0.02...
014e7918-dd9b-4a8e-8419-d1f50df06796
Continuous transforms use transform checkpoints based on a configurable check interval time (transform frequency with a default value of 1 minute). In the diagram above, we assume ① a new checkpoint is created after the check interval time has elapsed. Now Elasticsearch checks for changes in the transforms' source ...
{"source_file": "concepts.md"}
[ -0.06077767536044121, -0.01581801287829876, 0.010419761762022972, -0.005044093355536461, 0.024422233924269676, -0.006524135358631611, -0.04174208268523216, -0.096389040350914, 0.15851229429244995, 0.014645189978182316, -0.008678003214299679, 0.07730842381715775, 0.08103654533624649, -0.047...
05fb5282-3ac1-482c-9632-e425dbeebdf0
For a more concrete example of Elasticsearch vs ClickHouse for incremental aggregates, see this example . The advantages of ClickHouse's approach include: Always-up-to-date aggregates : materialized views are always in sync with the source table. No background jobs : aggregations are pushed to insert time rat...
{"source_file": "concepts.md"}
[ -0.05864281579852104, -0.03206373378634453, -0.016035210341215134, 0.027827510610222816, -0.02076577953994274, -0.0468670129776001, -0.054475538432598114, -0.01010400801897049, 0.051037613302469254, 0.021908869966864586, -0.05552602931857109, -0.010831762105226517, 0.04754573851823807, -0....
d64305a0-468f-4dc2-a774-8d156b673c29
slug: /use-cases/observability/clickstack/migration/elastic/intro title: 'Migrating to ClickStack from Elastic' pagination_prev: null pagination_next: null sidebar_label: 'Overview' sidebar_position: 0 description: 'Overview for migrating to the ClickHouse Observability Stack from Elastic' show_related_blogs: true keyw...
{"source_file": "intro.md"}
[ -0.002031402662396431, -0.08671502023935318, 0.00779880303889513, -0.002805509138852358, 0.03696237877011299, -0.016318580135703087, 0.0025891955010592937, -0.010482552461326122, -0.023915696889162064, 0.05695747956633568, -0.003146061673760414, -0.005765283480286598, 0.016110900789499283, ...
40ee536e-a0c9-4e7d-9245-04b596512ba1
slug: /use-cases/observability/clickstack/migration/elastic title: 'Migrating to ClickStack from Elastic' pagination_prev: null pagination_next: null description: 'Landing page migrating to the ClickHouse Observability Stack from Elastic' show_related_blogs: true keywords: ['Elasticsearch'] doc_type: 'landing-page' ...
{"source_file": "index.md"}
[ 0.004333311691880226, -0.07399535924196243, -0.01772606000304222, 0.01590684987604618, 0.009733045473694801, -0.06431043148040771, -0.0301890280097723, -0.029385140165686607, -0.05789578706026077, 0.06232360005378723, -0.015467067249119282, -0.035294193774461746, 0.031386204063892365, -0.0...
52204eb1-cce7-4d0d-b65c-efcaaf5d8890
slug: /use-cases/observability/clickstack/migration/elastic/types title: 'Mapping types' pagination_prev: null pagination_next: null sidebar_label: 'Types' sidebar_position: 2 description: 'Mapping types in ClickHouse and Elasticsearch' show_related_blogs: true keywords: ['JSON', 'Codecs'] doc_type: 'reference' Ela...
{"source_file": "types.md"}
[ 0.04988925904035568, -0.04843190684914589, 0.010015508159995079, 0.00789966806769371, -0.0036615876015275717, 0.013091955333948135, -0.05416389927268028, 0.005204475950449705, -0.026113761588931084, 0.02535177581012249, 0.014544375240802765, 0.0377492792904377, 0.018129026517271996, 0.0443...
8dcead01-44ea-4698-8a01-f4bc32569e8f
| Elasticsearch Type | ClickHouse Equivalent | Comments | |-------------------------------|------------------------------|--------------| | boolean | UInt8 or Bool | ClickHouse supports Boolean as an alias for UInt8 in newer versions. | | keyword ...
{"source_file": "types.md"}
[ -0.005005724262446165, 0.0006275647319853306, -0.018264111131429672, 0.027260031551122665, -0.005771252792328596, -0.026607854291796684, 0.021649429574608803, 0.005253928247839212, -0.032257210463285446, 0.007140045985579491, 0.012368916533887386, -0.020095935091376305, 0.07580288499593735, ...
22e419a2-b7f3-4e98-b251-5d4ba286e9a0
| alias | Alias column modifier | Aliases are supported through a field modifier. Functions can be applied to these alias e.g. size String ALIAS formatReadableSize(size_bytes) | | range types ( *_range ) | Tuple(start, end) or Array(T) | ClickHouse has no native range type, b...
{"source_file": "types.md"}
[ 0.026417642831802368, -0.020660191774368286, -0.04243889078497887, -0.033505938947200775, -0.04270898178219795, 0.0718475729227066, 0.03902300447225571, 0.02825869247317314, -0.01637864299118519, -0.015994498506188393, -0.013655956834554672, -0.06624696403741837, 0.049161069095134735, 0.00...
6436b191-2571-4a1b-a6dd-d18e4e155359
Notes {#notes} Arrays : In Elasticsearch, all fields support arrays natively. In ClickHouse, arrays must be explicitly defined (e.g., Array(String) ), with the advantage specific positions can be accessed and queried e.g. an_array[1] . Multi-fields : Elasticsearch allows indexing the same field multiple ways ...
{"source_file": "types.md"}
[ 0.065378837287426, 0.04954066127538681, -0.03320862352848053, -0.001200617291033268, -0.017909985035657883, -0.0157232116907835, -0.007227311376482248, -0.029515482485294342, 0.042184919118881226, -0.0044097937643527985, -0.02869095467031002, 0.0042788442224264145, 0.03632137551903725, 0.0...
28382dcf-1e8b-45ff-bfdc-41c90a43038d
slug: /use-cases/observability/clickstack/migration/elastic/migrating-data title: 'Migrating data to ClickStack from Elastic' pagination_prev: null pagination_next: null sidebar_label: 'Migrating data' sidebar_position: 4 description: 'Migrating data to ClickHouse Observability Stack from Elastic' show_related_blogs: t...
{"source_file": "migrating-data.md"}
[ -0.028786027804017067, -0.05762377008795738, -0.027509905397892, -0.026067541912198067, 0.015061215497553349, -0.04469146952033043, -0.0766843780875206, -0.026731226593255997, -0.02888886071741581, 0.08838425576686859, 0.028243977576494217, -0.014234155416488647, 0.04691450670361519, -0.01...
33bdf535-8209-478a-bc01-419fb30c2c1c
Migration timeline {#migration-timeline} The migration timeline will depend on your data retention requirements: 30-day retention : Migration can be completed within a month. Longer retention : Continue parallel operation until data expires from Elastic. Historical data : If absolutely necessary, consider usi...
{"source_file": "migrating-data.md"}
[ 0.01431718934327364, -0.06223748251795769, 0.023301120847463608, -0.022647593170404434, -0.0004101244849152863, -0.043344639241695404, -0.0846891850233078, -0.013373265042901039, -0.01848624460399151, 0.05057104676961899, 0.020921088755130768, 0.0032075669150799513, 0.017242757603526115, -...
d4a0f894-cf0a-42cc-ad22-6aba6267df91
Small lookup tables used for data enrichment (e.g., user mappings, service catalogs) Business data stored in Elasticsearch that needs to be correlated with observability data, with ClickHouse's SQL capabilities and Business Intelligence integrations making it easier to maintain and query the data compared to Elastics...
{"source_file": "migrating-data.md"}
[ 0.08537328988313675, -0.028572313487529755, 0.000038934347685426474, 0.006904473528265953, 0.047520894557237625, -0.02830960601568222, -0.048011664301157, -0.015263194218277931, -0.02796526998281479, 0.02847588248550892, -0.03553576022386551, -0.03944261744618416, 0.014394697733223438, 0.0...
4fd80251-4e49-4298-9662-b7bff26037c0
```javascripton GET .ds-logs-system.syslog-default-2025.06.03-000001/_mapping { ".ds-logs-system.syslog-default-2025.06.03-000001": { "mappings": { "_meta": { "managed_by": "fleet", "managed": true, "package": { "name": "system" } }, "_data_stream_timest...
{"source_file": "migrating-data.md"}
[ 0.01854669488966465, 0.026099251583218575, 0.03752753138542175, 0.005839903838932514, 0.06249663606286049, -0.05807381495833397, 0.03375164791941643, 0.020978828892111778, 0.03509312868118286, 0.013300180435180664, 0.0029255568515509367, -0.011704116128385067, -0.03125487267971039, 0.07612...
bc1b75cd-4a1a-4e30-86a0-ba3c84b358db
"data_stream": { "properties": { "dataset": { "type": "constant_keyword", "value": "system.syslog" }, "namespace": { "type": "constant_keyword", "value": "default" }, "type": { "ty...
{"source_file": "migrating-data.md"}
[ 0.03512340411543846, 0.08811072260141373, 0.010374383069574833, 0.011921879835426807, 0.05402045696973801, -0.0313890315592289, 0.01643216237425804, -0.0025492568966001272, 0.03733810782432556, 0.04994766041636467, 0.005976173095405102, -0.08067678660154343, 0.023141494020819664, 0.0226602...
763d8c7e-4084-4d06-9844-36c6d2e92a0a
}, "kernel": { "type": "keyword", "ignore_above": 1024 }, "name": { "type": "keyword", "fields": { "text": { "type": "match_only_text" } ...
{"source_file": "migrating-data.md"}
[ -0.0037284039426594973, 0.08226578682661057, -0.00094617810100317, 0.019885797053575516, 0.03816644102334976, -0.04055017977952957, -0.01583382673561573, 0.03379363566637039, 0.001255989889614284, 0.01825321465730667, 0.002890521427616477, -0.014942731708288193, 0.034346114844083786, 0.007...
311f23c4-84e8-4b4f-963c-39b05a68cba5
The equivalent ClickHouse table schema: ClickHouse schema ```sql SET enable_json_type = 1; CREATE TABLE logs_system_syslog ( `@timestamp` DateTime, `agent` Tuple( ephemeral_id String, id String, name String, type String, version String), `cloud` Tuple( ...
{"source_file": "migrating-data.md"}
[ 0.08433981239795685, -0.054283227771520615, -0.01733669824898243, -0.005874996073544025, 0.020359551534056664, -0.045625850558280945, 0.037774693220853806, -0.05395308881998062, -0.02451440691947937, 0.08769191056489944, 0.04840622842311859, -0.11289618909358978, 0.03669889643788338, -0.03...
cd9273c7-de3f-48ca-ad28-c72f1e923b2e
This strict schema has a number of benefits: Data validation – enforcing a strict schema avoids the risk of column explosion, outside of specific structures. Avoids risk of column explosion : although the JSON type scales to potentially thousands of columns, where subcolumns are stored as dedicated columns, thi...
{"source_file": "migrating-data.md"}
[ -0.04616725817322731, 0.00043279127567075193, -0.0621812641620636, 0.028796549886465073, 0.012590854428708553, -0.07938069105148315, -0.1014660969376564, 0.050731584429740906, 0.03779277950525284, -0.023229598999023438, 0.008320113644003868, 0.018600935116410255, -0.02176518738269806, 0.05...
608f2596-7ea5-41ea-b498-b1fe2fd84f3c
Exports data directly to JSON format, which can be streamed to the ClickHouse client for insertion. Where possible, we recommend running both ClickHouse, Elasticsearch, and elastic dump in the same availability zone or data center to minimize network egress and maximize throughput. Install ClickHouse client {#i...
{"source_file": "migrating-data.md"}
[ 0.0553167350590229, -0.022140642628073692, -0.056510452181100845, 0.001033411710523069, 0.032344751060009, -0.049603287130594254, -0.034584417939186096, 0.024787455797195435, -0.026211924850940704, 0.0782845988869667, -0.051365673542022705, -0.041112080216407776, 0.015150666236877441, 0.01...