id
stringlengths
36
36
document
stringlengths
3
3k
metadata
stringlengths
23
69
embeddings
listlengths
384
384
2186583b-75ec-4158-8520-6781414223f3
input. This is a SQL SELECT expression for the columns to select in the search page. Aliases are not supported at this time (ex. you can not use column as "alias" ). Saved searches {#saved-searches} You can save your searches for quick access later. Once saved, your searches will appear in the left sidebar, making...
{"source_file": "search.md"}
[ -0.019698427990078926, 0.018581023439764977, -0.08894921839237213, 0.12482550740242004, 0.07834813743829727, 0.08223447948694229, 0.07838514447212219, 0.030866924673318863, 0.06354139745235443, -0.04336061701178551, -0.0006238460191525519, 0.0384233258664608, 0.11747684329748154, -0.059138...
1cce746c-702b-4f6b-bd8e-e358bcc2fe72
slug: /use-cases/observability/clickstack/architecture pagination_prev: null pagination_next: null description: 'Architecture of ClickStack - The ClickHouse Observability Stack' title: 'Architecture' doc_type: 'reference' keywords: ['ClickStack architecture', 'observability architecture', 'HyperDX', 'OpenTelemetry coll...
{"source_file": "architecture.md"}
[ -0.037407200783491135, -0.040942076593637466, -0.08869706839323044, -0.004402144346386194, -0.03586730733513832, -0.08872827887535095, 0.004814648535102606, 0.01501692645251751, -0.02338910847902298, 0.04341479390859604, -0.02866029366850853, -0.02554178051650524, 0.009399107657372952, 0.0...
c1b7f9d8-76b6-497b-92fd-656e0f64b662
Dashboards Alerts User profiles Saved visualizations This separation of state from event data ensures performance and scalability while simplifying backup and configuration. This modular architecture enables ClickStack to deliver an out-of-the-box observability platform that is fast, flexible, and open-sour...
{"source_file": "architecture.md"}
[ -0.08177251368761063, -0.02462325431406498, -0.0696600005030632, 0.019597645848989487, 0.07390260696411133, -0.0433318130671978, 0.10351278632879257, 0.02313067577779293, -0.018335828557610512, -0.023024573922157288, -0.021574120968580246, 0.015086475759744644, 0.07258989661931992, 0.02250...
82ec302a-1293-4b3f-96c8-faf73b7cf795
slug: /use-cases/observability/clickstack/overview title: 'ClickStack - The ClickHouse Observability Stack' sidebar_label: 'Overview' pagination_prev: null pagination_next: use-cases/observability/clickstack/getting-started description: 'Overview for ClickStack - The ClickHouse Observability Stack' doc_type: 'guide' ke...
{"source_file": "overview.md"}
[ -0.01669582538306713, -0.019079649820923805, -0.07000533491373062, -0.026217278093099594, 0.025247352197766304, -0.09252582490444183, 0.0677991732954979, 0.015086633153259754, -0.05815216898918152, 0.04751535505056381, 0.03267360106110573, 0.009134008549153805, 0.04567256197333336, 0.00961...
f1b388bf-88d6-4ce8-bb5b-a289df4705e0
OpenTelemetry collector – a custom-built, preconfigured collector with an opinionated schema for logs, traces, and metrics ClickHouse – the high-performance analytical database at the heart of the stack These components can be deployed independently or together. A browser-hosted version of the HyperDX UI is als...
{"source_file": "overview.md"}
[ 0.0005163070163689554, -0.0741896703839302, -0.055876873433589935, 0.03128513693809509, -0.09967275708913803, -0.05528000369668007, -0.005621837452054024, -0.0018667642725631595, -0.10705064982175827, 0.00990890059620142, 0.0005404317635111511, -0.04356992244720459, -0.0013813039986416698, ...
90b6fdf1-c089-493e-94df-01d0bf82df99
Architectural overview {#architectural-overview} ClickStack consists of three core components: HyperDX UI A user-friendly interface built for observability. It supports both Lucene-style and SQL queries, interactive dashboards, alerting, trace exploration, and more—all optimized for ClickHouse as the back...
{"source_file": "overview.md"}
[ -0.03766658157110214, -0.038628097623586655, -0.09084483236074448, 0.03636862710118294, -0.04237973690032959, -0.0849628746509552, 0.03300061821937561, -0.002525139367207885, -0.0633828341960907, 0.003759104758501053, -0.06205372512340546, -0.04488355293869972, 0.010045698843896389, -0.003...
b0165268-5aeb-439a-94ed-3ce22df753c0
slug: /use-cases/observability/clickstack/ttl title: 'Managing TTL' sidebar_label: 'Managing TTL' pagination_prev: null pagination_next: null description: 'Managing TTL with ClickStack' doc_type: 'guide' keywords: ['clickstack', 'ttl', 'data retention', 'lifecycle', 'storage management'] import observability_14 fro...
{"source_file": "ttl.md"}
[ -0.05888492241501808, 0.01205233670771122, -0.052059050649404526, 0.052358198910951614, -0.01529557816684246, -0.056305497884750366, 0.051300421357154846, 0.028018880635499954, 0.014737790450453758, 0.008843054063618183, 0.06614356487989426, 0.08841577917337418, 0.08177001774311066, 0.0262...
fcf01e7d-72b6-4d68-8517-b834357bd953
By default, ClickStack retains data for 3 days. To modify this, see "Modifying TTL" . TTL is controlled at a table level in ClickHouse. For example, the schema for logs is shown below: sql CREATE TABLE default.otel_logs ( `Timestamp` DateTime64(9) CODEC(Delta(8), ZSTD(1)), `TimestampTime` DateTime DEFAULT ...
{"source_file": "ttl.md"}
[ -0.03787831962108612, -0.050710953772068024, -0.036200862377882004, 0.05376473814249039, -0.03009280003607273, -0.07767608016729355, 0.0866309255361557, -0.015426275320351124, 0.009089233353734016, 0.008193218149244785, 0.03659761697053909, -0.011045102030038834, 0.008906724862754345, -0.0...
9b40dd97-5fc9-414f-aed5-f3d248ea85c4
As shown in the above example, partitioning is specified on a table when it is initially defined via the PARTITION BY clause. This clause can contain an SQL expression on any column/s, the results of which will define which partition a row is sent to. This causes data to be logically associated (via a common folder n...
{"source_file": "ttl.md"}
[ -0.06809306889772415, -0.028790121898055077, 0.04472717270255089, 0.06608977913856506, 0.05824388563632965, -0.06029033288359642, 0.03926197439432144, 0.01664086990058422, 0.05922543630003929, 0.005841147154569626, 0.04370661452412605, -0.01589614897966385, 0.017044978216290474, 0.04303764...
9043e93f-cc6a-4b38-b2c3-12c970b38a13
sql ALTER TABLE default.otel_logs MODIFY TTL TimestampTime + toIntervalDay(7); Modify the OTel collector . The ClickStack OpenTelemetry collector creates tables in ClickHouse if they do not exist. This is achieved via the ClickHouse exporter, which itself exposes a ttl parameter used for controlling the default T...
{"source_file": "ttl.md"}
[ -0.033354196697473526, -0.001289032050408423, -0.028910938650369644, 0.053508806973695755, -0.0664074718952179, -0.07836088538169861, 0.012853607535362244, 0.0013393114786595106, 0.07520831376314163, 0.050144460052251816, 0.03996757045388222, -0.02896924503147602, -0.03262357786297798, -0....
656cbcd8-9831-41aa-a331-9e9583f1cffa
slug: /use-cases/observability/clickstack/production title: 'Going to Production' sidebar_label: 'Production' pagination_prev: null pagination_next: null description: 'Going to production with ClickStack' doc_type: 'guide' keywords: ['clickstack', 'production', 'deployment', 'best practices', 'operations'] import I...
{"source_file": "production.md"}
[ 0.019092341884970665, -0.006262603681534529, 0.010442640632390976, -0.05193528160452843, -0.015617146156728268, -0.04350929707288742, 0.062432195991277695, -0.02121388539671898, -0.06418139487504959, 0.08169570565223694, 0.08539070934057236, 0.013993714936077595, 0.06847075372934341, -0.00...
ef08d8e7-c9b9-498e-a7b9-10c3da505680
You can generate a strong secret using openssl: shell openssl rand -hex 32 Avoid committing secrets to source control. In production, consider using environment variable management tools (e.g. Docker Secrets, HashiCorp Vault, or environment-specific CI/CD configs). Secure ingestion {#secure-ingestion} All inges...
{"source_file": "production.md"}
[ 0.017343822866678238, 0.05114476755261421, -0.03491310030221939, -0.042905572801828384, -0.068232461810112, -0.021166669204831123, 0.04648217558860779, -0.04527595639228821, -0.030324643477797508, -0.0011896647047251463, -0.01429494097828865, -0.059149909764528275, 0.07641245424747467, -0....
83db7760-24b4-4268-afea-26b1b6528de7
Enable Role-Based Access Control (RBAC) to grant granular privileges. See operations/access-rights . Enforce quotas and limits using quotas , settings profiles , and read-only modes. Encrypt data at rest and use secure external storage. See operations/storing-data and cloud/security/CMEK . Avoid hard cod...
{"source_file": "production.md"}
[ -0.030421821400523186, 0.021729085594415665, -0.06355518102645874, 0.03940655291080475, -0.02003561519086361, -0.049195632338523865, -0.0013178411172702909, -0.01097862794995308, -0.00037379650166258216, 0.0740789994597435, -0.0559903159737587, -0.026992224156856537, -0.001423677778802812, ...
e8a720a0-c8fd-4334-9093-79190db633b7
Navigate to the HyperDX UI {#navigate-to-hyperdx-ui} Visit http://localhost:8080 to access the HyperDX UI. Create a user, providing a username and password which meets the requirements. On clicking Create you'll be prompted for connection details. Connect to ClickHouse Cloud {#connect-to-clickhouse-cloud...
{"source_file": "production.md"}
[ 0.04375125467777252, -0.055080823600292206, -0.004449116066098213, 0.0037222970277071, -0.07019901275634766, -0.00909090880304575, 0.022734185680747032, -0.06516003608703613, -0.07523856312036514, 0.028819017112255096, 0.023332275450229645, -0.022724593058228493, 0.036081477999687195, -0.0...
20f72fe8-192f-426e-8b05-520192f5f8fb
slug: /use-cases/observability/clickstack/getting-started title: 'Getting Started with ClickStack' sidebar_label: 'Getting started' pagination_prev: null pagination_next: use-cases/observability/clickstack/example-datasets/index description: 'Getting started with ClickStack - The ClickHouse Observability Stack' doc_typ...
{"source_file": "getting-started.md"}
[ 0.03312010318040848, 0.008096423000097275, -0.008054106496274471, -0.034811899065971375, -0.029197828844189644, -0.04950866103172302, 0.055854327976703644, 0.006546977907419205, -0.100723035633564, 0.03106813132762909, 0.05879286304116249, -0.023283183574676514, 0.05813794955611229, 0.0049...
7c6634f3-fd9f-4d8e-9af1-6380e0ba8084
For example: ```shell modify command to mount paths docker run \ -p 8080:8080 \ -p 4317:4317 \ -p 4318:4318 \ -v "$(pwd)/.volumes/db:/data/db" \ -v "$(pwd)/.volumes/ch_data:/var/lib/clickhouse" \ -v "$(pwd)/.volumes/ch_logs:/var/log/clickhouse-server" \ docker.hyperdx.io/hyperdx/hyperdx-all-in-one `...
{"source_file": "getting-started.md"}
[ 0.06545206159353256, -0.03565061837434769, -0.0007969765574671328, -0.04451970383524895, -0.04021056741476059, 0.0028987533878535032, 0.009207314811646938, -0.011226347647607327, -0.03299969434738159, 0.019940322265028954, 0.004192071035504341, -0.05907837301492691, 0.04701913893222809, 0....
09c0837a-61af-4694-b4c6-bfe4f8964523
Create a user, providing a username and password which meets the complexity requirements. Create a ClickHouse Cloud connection {#create-a-cloud-connection} Navigate to Team Settings and click Edit for the Local Connection : Rename the connection to Cloud and complete the subsequent form with your Clic...
{"source_file": "getting-started.md"}
[ 0.030384860932826996, -0.03761899098753929, 0.013041277416050434, -0.0787435919046402, -0.06164059042930603, 0.02219046838581562, 0.02659270353615284, -0.04101599007844925, -0.014350519515573978, 0.04877413436770439, 0.03566352277994156, -0.02978159859776497, 0.05427984893321991, -0.025517...
43073ee4-1c1b-4953-8cd4-3d6b37ef452b
slug: /use-cases/observability/clickstack/config title: 'Configuration Options' pagination_prev: null pagination_next: null description: 'Configuration options for ClickStack - The ClickHouse Observability Stack' keywords: ['ClickStack configuration', 'observability configuration', 'HyperDX settings', 'collector config...
{"source_file": "config.md"}
[ 0.05533183366060257, 0.0080827372148633, 0.010287106037139893, -0.014981870539486408, -0.04697135463356972, -0.020968584343791008, 0.06405249238014221, -0.022786224260926247, -0.11249011009931564, 0.02417047880589962, 0.03545711934566498, -0.04995834454894066, 0.06039848178625107, 0.016971...
0d6e0a1a-34ba-4b97-8194-4e2e3c94d4cb
Logs Traces Metrics Sessions This configuration can be performed inside the application from Team Settings -> Sources , as shown below for logs: Each of these sources require at least one table specified on creation as well as a set of columns which allow HyperDX to query the data. If using the defaul...
{"source_file": "config.md"}
[ 0.015478731133043766, -0.07921531051397324, -0.0048102582804858685, 0.011824535205960274, -0.03590777516365051, -0.07735709846019745, 0.05482807010412216, -0.06749018281698227, 0.02537539228796959, 0.021497253328561783, -0.007712922524660826, -0.06559251993894577, 0.0040847198106348515, -0...
f8245968-c845-4bcd-a24e-ad1037c12263
| Setting | Description | Required | Inferred in Default Schema | Inferred Value | |-------------------------------|------------------------------------...
{"source_file": "config.md"}
[ 0.06943561136722565, 0.027602525427937508, -0.006816909182816744, -0.0006813944200985134, -0.04295583814382553, 0.024517258629202843, -0.0016741935396566987, 0.025647584348917007, -0.014201505109667778, -0.028164774179458618, 0.035358887165784836, -0.17964676022529602, 0.03440212830901146, ...
fd2063d3-f361-4bce-af1b-ebba98d61e85
Body | | Log Attributes Expression | Expression or column for custom log attributes. | Yes | Yes | LogAttributes | | Resource ...
{"source_file": "config.md"}
[ -0.03915626183152199, 0.010398579761385918, -0.052744340151548386, 0.056499648839235306, 0.06479077786207199, 0.0046895695850253105, 0.06374197453260422, -0.009403286501765251, -0.003956624306738377, 0.001410398748703301, 0.018725689500570297, -0.05217266082763672, 0.04012463614344597, 0.0...
e94f5565-6cf0-4368-858c-497b3bd516b3
Traces {#traces}
{"source_file": "config.md"}
[ -0.036402326077222824, -0.03164107725024223, 0.05007823556661606, 0.035290468484163284, 0.0360189788043499, -0.016516758129000664, 0.08890693634748459, -0.032125215977430344, -0.0000566315466130618, -0.057664815336465836, 0.022967806085944176, 0.04482262581586838, 0.004191929008811712, -0....
13adbd51-488b-4083-88fb-a958918b59f8
| Setting | Description | Required | Inferred in Default Schema | Inferred Value | |----------------------------------|------------------------------------------------------------...
{"source_file": "config.md"}
[ 0.03726539388298988, 0.03187599033117294, -0.018426187336444855, 0.006622951943427324, -0.034554529935121536, -0.0030007055029273033, 0.025075120851397514, 0.009040884673595428, 0.006035314407199621, -0.041647542268037796, 0.027610139921307564, -0.19234876334667206, 0.046679265797138214, -...
81eb95cf-9f9f-4c60-89c4-bfe78b2781e3
TraceId | | Span Id Expression | Expression or column for span IDs. | Yes | Yes | SpanId | | Parent Span Id Expression | Expression or column for parent s...
{"source_file": "config.md"}
[ -0.029709845781326294, -0.03970544785261154, -0.01982002891600132, 0.06474200636148453, 0.013327940367162228, 0.01429489441215992, 0.03966277465224266, -0.03996193781495094, -0.004127128981053829, 0.03637447953224182, 0.03668863698840141, -0.03939293697476387, 0.04911326617002487, 0.008681...
42f9e32d-f29b-4c0d-81cb-2ab87b77ec44
Nested type column. This allows rendering of exception stack traces with supported language SDKs. | Yes | Yes | Events | | Implicit Column Expression | Column used for full-text search if no field is specified (Lucene-...
{"source_file": "config.md"}
[ 0.0036419846583157778, 0.05586322396993637, -0.017900051549077034, 0.04196235537528992, 0.008951687254011631, -0.019826753064990044, 0.03222467005252838, 0.04290401563048363, 0.007859543897211552, -0.016510002315044403, 0.02460739202797413, -0.03027556650340557, 0.0028709250036627054, 0.00...
19bdd907-9b22-4af7-9c9d-d3d7e6f50ae5
Metrics {#metrics} | Setting | Description | Required | Inferred in Default Schema | Inferred Value | |------------------------|---------------------------------------------------------------------------------...
{"source_file": "config.md"}
[ 0.02533736824989319, -0.05529149994254112, -0.10587310045957565, 0.03526031970977783, -0.13210973143577576, -0.028986381366848946, 0.03104885295033455, -0.048820432275533676, 0.037899721413850784, -0.024300994351506233, 0.0319676399230957, -0.14619338512420654, 0.04781029373407364, 0.00652...
b8abe4b3-50bb-41c1-b0c6-870b8e658048
Sessions {#settings} | Setting | Description | Required | Inferred in Default Schema | Inferred Value | |-------------------------------|--------------------------------------------------------------...
{"source_file": "config.md"}
[ 0.011571502313017845, 0.024956610053777695, -0.07460600882768631, 0.0038842211943119764, -0.09706207364797592, -0.02748004160821438, 0.04476324841380119, -0.02433576062321663, 0.0545228011906147, 0.021753231063485146, 0.000943195482250303, -0.1167621985077858, 0.02418830804526806, 0.045070...
704d210f-001d-4316-b3a9-d92bcd30da54
Traces : Can be correlated with logs, sessions, and metrics. Metrics : Can be correlated with logs. Sessions : Can be correlated with traces. By setting these correlations, HyperDX can, for example, render relevant logs alongside a trace or surface metric anomalies linked to a session. Proper configuration ensu...
{"source_file": "config.md"}
[ 0.05705547705292702, -0.030863497406244278, 0.004985261242836714, -0.03484467789530754, -0.03514914587140083, -0.03451542556285858, 0.05229714512825012, -0.0555138923227787, -0.009507331997156143, 0.0390128493309021, -0.007298387587070465, -0.04272099584341049, 0.046633027493953705, 0.0483...
a4ebd0b2-a003-488b-9269-d225095e71c2
Helps identify the HyperDX service in telemetry data NEXT_PUBLIC_OTEL_EXPORTER_OTLP_ENDPOINT Default: http://localhost:4318 Description: OpenTelemetry collector endpoint. Guidance: Relevant of self-instrumenting HyperDX. Use default for local development Set to your collector URL in production ...
{"source_file": "config.md"}
[ 0.017006445676088333, 0.04170485958456993, 0.02285384200513363, -0.041087836027145386, -0.01856468990445137, -0.061672624200582504, 0.01870151422917843, -0.04093927517533302, -0.05636065825819969, 0.024497542530298233, 0.05926572158932686, -0.007496120408177376, -0.047453004866838455, -0.0...
57dd451f-7084-4b8b-922a-1680a876623b
Store securely via secrets in production deployments HYPERDX_LOG_LEVEL Default: info Description: Log verbosity level for the collector. Guidance: Accepts values like debug , info , warn , error Use debug during troubleshooting OPAMP_SERVER_URL Default: Non...
{"source_file": "config.md"}
[ 0.014055430889129639, 0.024336524307727814, -0.03129687160253525, -0.01942797191441059, -0.08554154634475708, -0.08975011855363846, 0.018193000927567482, -0.028745409101247787, -0.027083048596978188, 0.024623852223157883, 0.031584277749061584, -0.07133916765451431, 0.002141752280294895, -0...
584e4844-bfb7-4169-9fb6-65235061dcdb
slug: /use-cases/observability/clickstack/event_deltas title: 'Event Deltas with ClickStack' sidebar_label: 'Event Deltas' pagination_prev: null pagination_next: null description: 'Event Deltas with ClickStack' doc_type: 'guide' keywords: ['clickstack', 'event deltas', 'change tracking', 'logs', 'observability'] im...
{"source_file": "event_deltas.md"}
[ 0.023796042427420616, 0.00708071468397975, 0.004802543669939041, -0.00900746788829565, -0.011793479323387146, 0.022346878424286842, 0.058033280074596405, -0.010245838202536106, -0.04722202941775322, 0.027110496535897255, 0.08537661284208298, -0.03757145255804062, 0.0164318960160017, -0.000...
a7db4cff-f6e6-4911-993c-e3844e251782
Users can then select an area of the visualization - ideally one with higher duration spans and sufficient density, followed by Filter by Selection . This designates the "outliers" for analysis. Event Deltas will then identify the columns and key values most associated with those spans in this outlier subset compared ...
{"source_file": "event_deltas.md"}
[ -0.0032192636281251907, -0.010125930421054363, -0.06898446381092072, 0.033613987267017365, 0.04633759334683418, -0.03779938817024231, 0.11898472160100937, -0.005111196544021368, -0.0043032532557845116, -0.0754338949918747, -0.0320618562400341, -0.033254388719797134, -0.013145238161087036, ...
3f725d6b-ed64-4e29-a097-aa5e39251814
By default, the visualization uses: Y Axis : Duration — displays latency values vertically Color (Z Axis) : count() — represents the number of requests over time (X axis) This setup shows latency distribution across time, with color intensity indicating how many events fall within each range. Adjusting ...
{"source_file": "event_deltas.md"}
[ 0.04626154899597168, -0.046851322054862976, -0.03130296245217323, 0.014892077073454857, 0.026164604350924492, 0.016115644946694374, 0.020904436707496643, -0.016103290021419525, 0.1492564082145691, -0.04909384623169899, -0.04732203111052513, -0.07204421609640121, 0.018691662698984146, 0.030...
4c4a253c-012f-425d-9f3f-a2caa07f0e5c
slug: /use-cases/observability/clickstack title: 'ClickStack - The ClickHouse Observability Stack' pagination_prev: null pagination_next: null description: 'Landing page for the ClickHouse Observability Stack' keywords: ['ClickStack', 'observability stack', 'HyperDX', 'OpenTelemetry', 'logs', 'traces', 'metrics'] doc_t...
{"source_file": "index.md"}
[ -0.03562381863594055, -0.08226573467254639, -0.03808891028165817, -0.0002865304995793849, -0.005833118222653866, -0.09781159460544586, 0.03225362300872803, -0.009995377622544765, -0.06688085198402405, 0.026669133454561234, 0.005883034318685532, -0.0017630645306780934, 0.025981733575463295, ...
ed67576c-0d04-40fd-949d-0d631d0a6149
slug: /use-cases/observability/clickstack/alerts title: 'Search with ClickStack' sidebar_label: 'Alerts' pagination_prev: null pagination_next: null description: 'Alerts with ClickStack' doc_type: 'guide' keywords: ['ClickStack', 'observability', 'alerts', 'search-alerts', 'notifications', 'thresholds', 'slack', 'email...
{"source_file": "alerts.md"}
[ 0.007746604736894369, 0.01633346639573574, -0.061682526022195816, 0.04442691430449486, 0.03967465087771416, 0.008761637844145298, 0.0785253494977951, 0.06797000020742416, -0.027497002854943275, -0.031447865068912506, 0.038339465856552124, -0.005483279004693031, 0.12419315427541733, 0.02781...
15f35d79-5af0-436a-9b71-8557428500f7
Open alert creation dialog {#open-dialog} Start by entering a search and clicking the Alerts button in the top-right corner of the Search page. Create the alert {#create-the-alert} From the alert creation panel, you can: Assign a name to the saved search associated with the alert. Set a threshold an...
{"source_file": "alerts.md"}
[ -0.047259796410799026, -0.017174098640680313, -0.06731880456209183, 0.047534581273794174, 0.0559089332818985, -0.028537027537822723, 0.07199566066265106, -0.02766719087958336, 0.12961561977863312, -0.057694144546985626, -0.05009777843952179, -0.06413312256336212, 0.12134764343500137, -0.00...
f3f9be24-64c7-4cbc-996c-31fefb06c893
This opens the webhook creation dialog, where users can create a new webhook: A webhook name is required, while descriptions are optional. Other settings that must be completed depend on the service type. Note that different service types are available between ClickStack Open Source and ClickStack Cloud. See Ser...
{"source_file": "alerts.md"}
[ -0.08901060372591019, -0.06186579912900925, -0.07321752607822418, -0.018060902133584023, 0.005202409345656633, -0.04837596043944359, 0.0533100850880146, -0.008414902724325657, 0.020075682550668716, 0.016515180468559265, -0.006046855356544256, -0.05362333357334137, 0.039308976382017136, -0....
5caf7f3f-73f2-4e16-b86d-ba29b5c33ed0
Common alert scenarios {#common-alert-scenarios} Here are a few common alert scenarios you can use HyperDX for: Errors: We recommend setting up alerts for the default All Error Events and HTTP Status >= 400 saved searches to be notified when excess errors occur. Slow Operations: You can set up a search for ...
{"source_file": "alerts.md"}
[ 0.049187880009412766, 0.001965841744095087, -0.005673369858413935, 0.02197110466659069, 0.03406653180718422, -0.03333038464188576, 0.04965974763035774, -0.004252343904227018, 0.0340450294315815, -0.003244385588914156, -0.008626970462501049, -0.028728576377034187, 0.011328569613397121, 0.03...
9f40d4a5-8280-45e0-b148-42c8a34526c4
slug: /use-cases/observability/clickstack/event_patterns title: 'Event Patterns with ClickStack' sidebar_label: 'Event Patterns' pagination_prev: null pagination_next: null description: 'Event Patterns with ClickStack' doc_type: 'guide' keywords: ['clickstack', 'event patterns', 'log analysis', 'pattern matching', 'obs...
{"source_file": "event_patterns.md"}
[ -0.010482889600098133, -0.04110188037157059, 0.006026016548275948, 0.02918797731399536, 0.08353812247514725, -0.04260115697979927, 0.0648239254951477, 0.004690833855420351, -0.007848460227251053, 0.02045103721320629, -0.01925484463572502, -0.006195463240146637, 0.04508562013506889, 0.03882...
e4ded725-e5d9-4910-8399-cc0621808401
slug: /use-cases/observability/clickstack/dashboards title: 'Visualizations and Dashboards with ClickStack' sidebar_label: 'Dashboards' pagination_prev: null pagination_next: null description: 'Visualizations and Dashboards with ClickStack' doc_type: 'guide' keywords: ['clickstack', 'dashboards', 'visualization', 'moni...
{"source_file": "dashboards.md"}
[ 0.025979764759540558, 0.01831459254026413, -0.058361154049634933, -0.044097576290369034, 0.010735012590885162, -0.038152679800987244, 0.04966580122709274, 0.043824490159749985, -0.09777412563562393, 0.03004705160856247, 0.05967158079147339, -0.020180638879537582, 0.10988098382949829, 0.014...
cceb6512-feec-4725-813e-7bf8a0873920
For example, you might chart the number of errors ( count() ) grouped by service name. For the examples below, we use the remote dataset available at sql.clickhouse.com , described in the guide "Remote Demo Dataset" . Users can also reproduce these examples by visiting play-clickstack.clickhouse.com . Navigat...
{"source_file": "dashboards.md"}
[ 0.019279783591628075, -0.09073930978775024, -0.011227568611502647, 0.0237690731883049, -0.05449070408940315, -0.002329545561224222, 0.08494585752487183, 0.02545842155814171, 0.03240833058953285, 0.007287259213626385, -0.04719451069831848, -0.03627460449934006, 0.09668527543544769, -0.00520...
1f5575d6-95c0-47f1-8cd0-cb7606eb35d6
Create a visualization – average request time by service {#create-a-tile} Select Add New Tile to open the visualization creation panel. Select the Line/Bar visualization type from the top menu, followed by the Traces (or Demo Traces if using play-clickstack.clickhouse.com ) dataset. Complete the following ...
{"source_file": "dashboards.md"}
[ 0.01850030943751335, -0.0592937245965004, -0.0221637524664402, -0.031182758510112762, -0.06149757653474808, -0.006502329837530851, 0.030619926750659943, 0.026166966184973717, 0.052534863352775574, 0.04504712298512459, -0.05527461692690849, -0.03769264370203018, 0.010536675341427326, 0.0374...
3a25f99d-3e02-4526-b511-db783bc193ac
:::note Required system table access This dashboard queries the ClickHouse system tables to expose key metrics. The following grants are required: GRANT SHOW COLUMNS, SELECT(CurrentMetric_MemoryTracking, CurrentMetric_S3Requests, ProfileEvent_OSCPUVirtualTimeMicroseconds, ProfileEvent_OSReadChars, ProfileEvent_OSWr...
{"source_file": "dashboards.md"}
[ 0.055301327258348465, -0.0466935932636261, -0.10966703295707703, -0.002109193941578269, 0.009461832232773304, -0.03240543231368065, 0.04566628858447075, 0.06527690589427948, 0.008981110528111458, 0.052873916923999786, -0.031636208295822144, -0.08255337923765182, 0.09946371614933014, -0.033...
c13cd098-48cf-45eb-96fc-28202ca30968
slug: /use-cases/observability/clickstack/ingesting-data/kubernetes pagination_prev: null pagination_next: null description: 'Kubernetes integration for ClickStack - The ClickHouse Observability Stack' title: 'Kubernetes' doc_type: 'guide' keywords: ['clickstack', 'kubernetes', 'logs', 'observability', 'container monit...
{"source_file": "kubernetes.md"}
[ 0.01993744820356369, -0.05690143629908562, 0.04257800057530403, -0.0319400355219841, -0.06092168018221855, -0.023148568347096443, 0.05580850690603256, -0.005017046816647053, 0.0540483221411705, 0.05037039518356323, -0.009555257856845856, -0.0860537439584732, -0.0028307505417615175, -0.0071...
e77edc67-a6cc-4818-9389-75c322ca344f
# Required to use the kubeletstats cpu/memory utilization metrics clusterRole: create: true rules: - apiGroups: - '' resources: - nodes/proxy verbs: - get presets: logsCollection: enabled: true hostMetrics: enabled: true # Configures the Kubernetes Processor to...
{"source_file": "kubernetes.md"}
[ 0.05433805286884308, 0.019236937165260315, -0.002443260746076703, 0.07896833121776581, -0.03139812871813774, 0.02789527364075184, 0.009679320268332958, -0.02027215249836445, 0.043638456612825394, 0.04596804082393646, -0.04285084083676338, -0.10515713691711426, -0.0051832436583936214, -0.03...
fe839b01-139a-42e1-86ec-21eff05ddd3a
Creating the deployment configuration {#creating-the-deployment-configuration} To collect Kubernetes events and cluster-wide metrics, we'll need to deploy a separate OpenTelemetry collector as a deployment. Download the deployment manifest: shell curl -O https://raw.githubusercontent.com/ClickHouse/clickhouse-doc...
{"source_file": "kubernetes.md"}
[ 0.01650558039546013, -0.025871792808175087, 0.01567528396844864, 0.03337142989039421, -0.07771120965480804, -0.029662584885954857, 0.0280857365578413, -0.06466720998287201, 0.07459694892168045, 0.04439087212085724, 0.044845160096883774, -0.1362195909023285, 0.016936343163251877, -0.0468781...
777c0898-17e3-443b-ad74-935db0320c36
Now the metrics, logs and Kubernetes events from your Kubernetes cluster should now appear inside HyperDX. Forwarding resource tags to pods (Recommended) {#forwarding-resouce-tags-to-pods} To correlate application-level logs, metrics, and traces with Kubernetes metadata (ex. pod name, namespace, etc.), you'll want ...
{"source_file": "kubernetes.md"}
[ 0.0841980129480362, -0.017416510730981827, 0.06535474956035614, -0.02168235555291176, -0.03028091974556446, -0.0185971949249506, 0.036325521767139435, -0.01787596009671688, 0.06636452674865723, 0.07836345583200455, -0.04628060385584831, -0.11335301399230957, 0.0055777826346457005, 0.014353...
593d7d36-e7c8-407e-8fe3-bb2f6f6e8cca
slug: /use-cases/observability/clickstack/ingesting-data/overview title: 'Ingesting data into ClickStack' sidebar_label: 'Overview' sidebar_position: 0 pagination_prev: null pagination_next: use-cases/observability/clickstack/ingesting-data/opentelemetry description: 'Overview for ingesting data to ClickStack' doc_type...
{"source_file": "overview.md"}
[ -0.028597384691238403, 0.007555300835520029, -0.07818667590618134, -0.002042002510279417, -0.014951221644878387, -0.09453055262565613, 0.08953770995140076, 0.044212955981492996, -0.00409697974100709, 0.008156429044902325, 0.03247467800974846, -0.04012702405452728, 0.05132119357585907, 0.00...
1b45df4f-b074-49c3-996c-e802c88e661f
slug: /use-cases/observability/clickstack/ingesting-data/schemas pagination_prev: null pagination_next: null description: 'Tables and schemas used by ClickStack - The ClickHouse Observability Stack' sidebar_label: 'Tables and schemas' title: 'Tables and schemas used by ClickStack' doc_type: 'reference' keywords: ['clic...
{"source_file": "schemas.md"}
[ 0.01627792976796627, -0.0896127000451088, -0.052631884813308716, 0.04304235056042671, -0.05816496163606644, -0.07068276405334473, 0.04475060850381851, -0.0040034144185483456, -0.042163945734500885, 0.04826169088482857, 0.07753156125545502, -0.069734126329422, 0.07640281319618225, -0.046224...
dd5c05a7-1cd7-4ccd-9476-02e45ef57186
Traces {#traces} sql CREATE TABLE otel_traces ( `Timestamp` DateTime64(9) CODEC(Delta(8), ZSTD(1)), `TraceId` String CODEC(ZSTD(1)), `SpanId` String CODEC(ZSTD(1)), `ParentSpanId` String CODEC(ZSTD(1)), `TraceState` String CODEC(ZSTD(1)), `SpanName` LowCardinality(String) CODEC(ZSTD(1)), `...
{"source_file": "schemas.md"}
[ -0.030039748176932335, -0.003991654142737389, -0.03715801239013672, 0.04280763864517212, -0.03979523852467537, -0.05679675564169884, 0.06876321136951447, -0.0016952604055404663, -0.0734972283244133, 0.020916955545544624, 0.050722748041152954, -0.06665560603141785, 0.06733119487762451, -0.0...
5a6e91c2-ef83-44d0-a978-5912e9116f8f
Metrics {#metrics} Gauge metrics {#gauge} sql CREATE TABLE otel_metrics_gauge ( `ResourceAttributes` Map(LowCardinality(String), String) CODEC(ZSTD(1)), `ResourceSchemaUrl` String CODEC(ZSTD(1)), `ScopeName` String CODEC(ZSTD(1)), `ScopeVersion` String CODEC(ZSTD(1)), `ScopeAttributes` Map(LowCa...
{"source_file": "schemas.md"}
[ -0.03287407383322716, -0.012417827732861042, -0.07120455056428909, 0.04494651034474373, -0.1119212955236435, -0.03115731105208397, 0.12781745195388794, 0.024187851697206497, -0.029040731489658356, 0.009915049187839031, 0.029956355690956116, -0.1424277126789093, 0.06112189218401909, -0.0019...
4b84d956-f279-4e0d-85c8-82f2828118a4
Sum metrics {#sum} sql CREATE TABLE otel_metrics_sum ( `ResourceAttributes` Map(LowCardinality(String), String) CODEC(ZSTD(1)), `ResourceSchemaUrl` String CODEC(ZSTD(1)), `ScopeName` String CODEC(ZSTD(1)), `ScopeVersion` String CODEC(ZSTD(1)), `ScopeAttributes` Map(LowCardinality(String), String) ...
{"source_file": "schemas.md"}
[ -0.014476053416728973, -0.0038482530508190393, -0.04601878672838211, 0.04266108199954033, -0.1072222888469696, -0.020296530798077583, 0.12347512692213058, 0.015347268432378769, -0.006056363228708506, 0.026639336720108986, 0.029808402061462402, -0.15009881556034088, 0.07599006593227386, -0....
55595ecc-3d1d-4452-9a05-5205426d1e8a
Histogram metrics {#histogram} sql CREATE TABLE otel_metrics_histogram ( `ResourceAttributes` Map(LowCardinality(String), String) CODEC(ZSTD(1)), `ResourceSchemaUrl` String CODEC(ZSTD(1)), `ScopeName` String CODEC(ZSTD(1)), `ScopeVersion` String CODEC(ZSTD(1)), `ScopeAttributes` Map(LowCardinality...
{"source_file": "schemas.md"}
[ 0.01980452612042427, 0.009225700981914997, -0.05951223149895668, -0.00002077290446322877, -0.14342014491558075, -0.024389613419771194, 0.11724434047937393, 0.03735531494021416, -0.0665934756398201, 0.02312324568629265, 0.024787677451968193, -0.14464685320854187, 0.11482129245996475, -0.029...
d1316f2f-8e1f-4e80-b22d-fdc4e09afdb7
:::note HyperDX does not support fetching/displaying exponential histogram metrics yet. Users may configure them in the metrics source but future support is forthcoming. ::: sql CREATE TABLE otel_metrics_exponentialhistogram ( `ResourceAttributes` Map(LowCardinality(String), String) CODEC(ZSTD(1)), `ResourceS...
{"source_file": "schemas.md"}
[ -0.005148846656084061, 0.02847849205136299, -0.06524042040109634, -0.00900962669402361, -0.1393759548664093, -0.00984782725572586, 0.06173279881477356, 0.012971804477274418, -0.01939311809837818, 0.01979149505496025, 0.040921349078416824, -0.1546514630317688, 0.04810483381152153, 0.0075058...
462fdf94-2b0f-46bb-bfec-222ed1ac141d
Summary table {#summary-table} sql CREATE TABLE otel_metrics_summary ( `ResourceAttributes` Map(LowCardinality(String), String) CODEC(ZSTD(1)), `ResourceSchemaUrl` String CODEC(ZSTD(1)), `ScopeName` String CODEC(ZSTD(1)), `ScopeVersion` String CODEC(ZSTD(1)), `ScopeAttributes` Map(LowCardinality(S...
{"source_file": "schemas.md"}
[ -0.0012873288942500949, 0.021916260942816734, -0.02755781263113022, 0.03523480147123337, -0.08034178614616394, -0.007371829356998205, 0.10469796508550644, 0.04704465717077255, -0.006156424060463905, 0.04914358630776405, 0.05267978832125664, -0.13916468620300293, 0.09008237719535828, -0.000...
0295aa5c-61e9-4059-b4f3-79a398b06628
Sessions {#sessions} sql CREATE TABLE hyperdx_sessions ( `Timestamp` DateTime64(9) CODEC(Delta(8), ZSTD(1)), `TimestampTime` DateTime DEFAULT toDateTime(Timestamp), `TraceId` String CODEC(ZSTD(1)), `SpanId` String CODEC(ZSTD(1)), `TraceFlags` UInt8, `SeverityText` LowCardinality(String) CODEC(...
{"source_file": "schemas.md"}
[ 0.025721553713083267, 0.07134436070919037, -0.033094774931669235, 0.04212617501616478, -0.09349429607391357, -0.032621316611766815, 0.11604837328195572, 0.03354867175221443, -0.04780960455536842, 0.04293423146009445, 0.023682348430156708, -0.0910218358039856, 0.04896943271160126, 0.0189813...
615f041d-c8a9-4c5f-b550-064fa7e6f966
slug: /use-cases/observability/clickstack/ingesting-data pagination_prev: null pagination_next: null description: 'Data ingestion for ClickStack - The ClickHouse Observability Stack' title: 'Ingesting data' doc_type: 'landing-page' keywords: ['ClickStack data ingestion', 'observability data ingestion ', 'ClickStack Ope...
{"source_file": "index.md"}
[ 0.014250868000090122, -0.05107275769114494, -0.034857381135225296, 0.010893680155277252, -0.058310262858867645, -0.06629953533411026, 0.04634682089090347, 0.0068761552684009075, -0.0620497465133667, -0.0005585898761637509, 0.04826712608337402, -0.03675533086061478, 0.02715834230184555, -0....
0e4808d8-2f42-49ad-b13f-3cabcb95368b
slug: /use-cases/observability/clickstack/ingesting-data/otel-collector pagination_prev: null pagination_next: null description: 'OpenTelemetry collector for ClickStack - The ClickHouse Observability Stack' sidebar_label: 'OpenTelemetry collector' title: 'ClickStack OpenTelemetry Collector' doc_type: 'guide' keywords: ...
{"source_file": "collector.md"}
[ -0.0316007062792778, -0.014840883202850819, -0.03512566536664963, 0.032471127808094025, -0.02732430212199688, -0.05140846222639084, 0.05076291039586067, -0.008035648614168167, -0.05795666202902794, -0.014710882678627968, 0.0770549327135086, -0.020493008196353912, 0.06732244789600372, -0.00...
eccf3632-c71f-42ca-8c2e-21766e71587f
Deploying the collector {#configuring-the-collector} If you are managing your own OpenTelemetry collector in a standalone deployment - such as when using the HyperDX-only distribution - we recommend still using the official ClickStack distribution of the collector for the gateway role where possible, but if you cho...
{"source_file": "collector.md"}
[ -0.001288906903937459, 0.0011249528033658862, -0.031448524445295334, -0.02697005681693554, -0.13115376234054565, -0.1138339415192604, 0.04715072363615036, -0.025017714127898216, -0.044815126806497574, 0.008536113426089287, 0.025357576087117195, -0.07737019658088684, -0.048720743507146835, ...
095dc568-73bf-401d-a76b-18cf25f3b797
Docker Compose {#docker-compose-otel} With Docker Compose, modify the collector configuration using the same environment variables as above: yaml otel-collector: image: hyperdx/hyperdx-otel-collector environment: CLICKHOUSE_ENDPOINT: 'https://mxl4k3ul6a.us-east-2.aws.clickhouse-staging.com:8443' ...
{"source_file": "collector.md"}
[ 0.026192206889390945, 0.01181352324783802, 0.045383427292108536, -0.04338190704584122, -0.07394614815711975, -0.11721456795930862, 0.014500400051474571, -0.06518205255270004, -0.00001890412750071846, 0.05251125246286392, 0.026450252160429955, -0.10513712465763092, -0.0013653718633577228, -...
a64097ea-c0c4-4b16-ae38-85f4be4caa07
Deploy with the standalone collector: bash docker run -d \ -e CUSTOM_OTELCOL_CONFIG_FILE=/etc/otelcol-contrib/custom.config.yaml \ -e OPAMP_SERVER_URL=${OPAMP_SERVER_URL} \ -e CLICKHOUSE_ENDPOINT=${CLICKHOUSE_ENDPOINT} \ -e CLICKHOUSE_USER=default \ -e CLICKHOUSE_PASSWORD=${CLICKHOUSE_PASSWORD} \ -v "$(pw...
{"source_file": "collector.md"}
[ 0.03727514669299126, -0.012524927966296673, -0.03758759796619415, -0.0682050809264183, -0.11923034489154816, -0.09730108082294464, 0.0209506843239069, -0.004148093052208424, -0.021501783281564713, 0.019003501161932945, 0.05304450914263725, -0.06515327841043472, -0.04036339744925499, -0.055...
f83ec54f-e78e-44f2-8938-21b4461cfff8
Processing - filtering, transforming, and enriching {#processing-filtering-transforming-enriching} Users will invariably want to filter, transform, and enrich event messages during ingestion. Since the configuration for the ClickStack connector cannot be modified, we recommend users who need further event filtering a...
{"source_file": "collector.md"}
[ -0.025442471727728844, -0.013322979211807251, 0.022382663562893867, -0.03690613433718681, -0.0282924622297287, -0.05459696799516678, 0.07758954167366028, -0.07584371417760849, 0.04447147995233536, -0.014536306262016296, -0.040113989263772964, -0.08352328091859818, -0.03550339117646217, -0....
b56845bf-b9f6-4552-a230-3bf53452e25e
We recommend users avoid doing excessive event processing using operators or transform processors . These can incur considerable memory and CPU overhead, especially JSON parsing. It is possible to do all processing in ClickHouse at insert time with materialized views and columns with some exceptions - specifically, c...
{"source_file": "collector.md"}
[ -0.02147049270570278, -0.008621837943792343, -0.05662026256322861, 0.0059751481749117374, -0.011879177764058113, -0.11547763645648956, 0.06104113161563873, -0.033399131149053574, 0.016758987680077553, 0.056146204471588135, -0.008996131829917431, -0.0012780700344592333, -0.005609816871583462,...
dcaf74ed-254a-43e8-ab72-f5df0d752f80
Batching {#batching} By default, each insert sent to ClickHouse causes ClickHouse to immediately create a part of storage containing the data from the insert together with other metadata that needs to be stored. Therefore sending a smaller amount of inserts that each contain more data, compared to sending a larger am...
{"source_file": "collector.md"}
[ -0.02675907127559185, -0.04402487725019455, 0.017819438129663467, 0.061813779175281525, -0.04701762646436691, -0.0896068811416626, -0.023603452369570732, 0.021060170605778694, 0.013779828324913979, 0.04144562408328056, 0.04758031666278839, 0.026569966226816177, 0.05896688625216484, -0.1169...
4771c4dd-c941-4f9c-a2e3-0d18fe078630
With asynchronous inserts enabled , when ClickHouse ① receives an insert query, the query's data is ② immediately written into an in-memory buffer first. When ③ the next buffer flush takes place, the buffer's data is sorted and written as a part to the database storage. Note, that the data is not searchable by queri...
{"source_file": "collector.md"}
[ -0.023416835814714432, -0.07248573005199432, -0.0809156522154808, 0.10968324542045593, -0.13427135348320007, -0.058087628334760666, -0.009245789609849453, -0.06705442816019058, 0.03878384083509445, 0.0029146282467991114, 0.04523543268442154, 0.009058709256350994, 0.02445741929113865, -0.11...
8239c685-491f-4d6e-a731-eb2cf3b85921
Adding Kafka {#adding-kafka} Readers may notice the above architectures do not use Kafka as a message queue. Using a Kafka queue as a message buffer is a popular design pattern seen in logging architectures and was popularized by the ELK stack. It provides a few benefits: principally, it helps provide stronger mess...
{"source_file": "collector.md"}
[ -0.015007780864834785, -0.029721645638346672, -0.0530984103679657, 0.03363143280148506, -0.023302774876356125, -0.08118540793657303, -0.02521361969411373, -0.02610415406525135, 0.14699497818946838, 0.07643276453018188, -0.05152394622564316, 0.019298652186989784, -0.02694276161491871, -0.06...
2f3c0213-c227-4de4-9f36-23abf6d9aca7
JSON support {#json-support} :::warning Beta Feature JSON type support in ClickStack is a beta feature . While the JSON type itself is production-ready in ClickHouse 25.3+, its integration within ClickStack is still under active development and may have limitations, change in the future, or contain bugs ::: Cl...
{"source_file": "collector.md"}
[ -0.10303118079900742, -0.03522857651114464, 0.02826656587421894, 0.05498812347650528, -0.0036234105937182903, -0.05584568530321121, -0.01259960513561964, 0.02711435779929161, -0.0341259241104126, -0.009672533720731735, -0.015650104731321335, 0.03452296555042267, -0.04362126812338829, 0.074...
f2cd02e4-b7aa-4b59-bb71-21f7776ccd71
To migrate from the Map-based schemas, follow these steps: Stop the OTel collector {#stop-the-collector} Rename existing tables and update sources {#rename-existing-tables-sources} Rename existing tables and update data sources in HyperDX. For example: sql RENAME TABLE otel_logs TO otel_logs_map; RENAME TA...
{"source_file": "collector.md"}
[ 0.07704243063926697, -0.04851725324988365, 0.060179319232702255, -0.05847398191690445, -0.059956397861242294, -0.012531537562608719, -0.03139307722449303, -0.07446197420358658, -0.08124158531427383, 0.048681650310754776, 0.01906212605535984, -0.10025788843631744, -0.019669029861688614, -0....
a5b61c05-7071-4320-885f-85c6bb37cf22
slug: /use-cases/observability/clickstack/ingesting-data/opentelemetry pagination_prev: null pagination_next: null description: 'Data ingestion with OpenTelemetry for ClickStack - The ClickHouse Observability Stack' title: 'Ingesting with OpenTelemetry' doc_type: 'guide' keywords: ['clickstack', 'opentelemetry', 'trace...
{"source_file": "opentelemetry.md"}
[ -0.010160761885344982, -0.023556755855679512, -0.05055539682507515, 0.012725023552775383, -0.017185965552926064, -0.1017945185303688, 0.12395472824573517, 0.03972991183400154, -0.005453243386000395, 0.0031524014193564653, 0.06345167011022568, -0.041853878647089005, 0.07387996464967728, 0.0...
9569ffd3-26e9-4c40-8482-a3ff29329ace
shell OTEL_EXPORTER_OTLP_HEADERS='authorization=<YOUR_INGESTION_API_KEY>' Agents should likewise include this authorization header in any OTLP communication. For example, if deploying a contrib distribution of the OTel collector in the agent role, they can use the OTLP exporter. An example agent config consuming th...
{"source_file": "opentelemetry.md"}
[ 0.027144618332386017, 0.02246113307774067, -0.03143758326768875, -0.0593000091612339, -0.031023593619465828, -0.08376345038414001, 0.03117530792951584, -0.02080894075334072, 0.005607838276773691, -0.017355406656861305, 0.05680442973971367, -0.09978093206882477, 0.008043266832828522, 0.0246...
ee9b9e31-b294-432d-81c9-4a0f42e3b356
slug: /use-cases/observability/clickstack/getting-started/kubernetes title: 'Monitoring Kubernetes' sidebar_position: 1 pagination_prev: null pagination_next: null description: 'Getting started with ClickStack and monitoring Kubernetes' doc_type: 'guide' keywords: ['clickstack', 'kubernetes', 'logs', 'observability', '...
{"source_file": "kubernetes.md"}
[ 0.022328659892082214, 0.0019323262386023998, 0.003981412388384342, -0.027941035106778145, -0.0036862404085695744, -0.04288075119256973, 0.07215514779090881, -0.006419568322598934, -0.004487469792366028, 0.04897429049015045, 0.05843493342399597, -0.05416623502969742, 0.03292781859636307, -0...
89e7ac2d-62a8-4458-a389-825a58e61f92
Deploy the OpenTelemetry Demo (Optional) {#deploy-otel-demo} This step is optional and intended for users with no existing pods to monitor . Although users with existing services deployed in their Kubernetes environment can skip, this demo does include instrumented microservices which generate trace and session repl...
{"source_file": "kubernetes.md"}
[ -0.005012334790080786, -0.05580403655767441, 0.05680673196911812, -0.019589563831686974, -0.03372364491224289, -0.10139372199773788, 0.04511437937617302, -0.04935280606150627, 0.028690379112958908, 0.03884658217430115, -0.004803177900612354, -0.08669256418943405, 0.0018676656764000654, -0....
0ecdb40d-824b-48a1-acf7-e975992c37c0
On deployment of the demo, confirm all pods have been successfully created and are in the Running state: ```shell kubectl get pods -n=otel-demo NAME READY STATUS RESTARTS AGE accounting-fd44f4996-fcl4k 1/1 Running 0 13m ad-769f968468-qq8mw ...
{"source_file": "kubernetes.md"}
[ 0.012213215231895447, -0.01919931173324585, 0.03534707427024841, -0.032054219394922256, -0.00036228576209396124, -0.0865900069475174, -0.037420883774757385, -0.02209712751209736, 0.017867952585220337, 0.06731000542640686, 0.05157307907938957, -0.09312814474105835, -0.02628902532160282, -0....
b5d19df6-fab0-4bba-8332-657ef184ffca
```shell helm install my-hyperdx hyperdx/hdx-oss-v2 --set clickhouse.persistence.dataSize=100Gi --set global.storageClassName="standard-rwo" -n otel-demo ``` :::warning ClickStack in production This chart also installs ClickHouse and the OTel collector. For production, it is recommended that you use the clickhouse ...
{"source_file": "kubernetes.md"}
[ 0.04458899050951004, 0.013548674061894417, 0.0015899413265287876, -0.002818926703184843, -0.02417352981865406, -0.040552541613578796, 0.01329884584993124, -0.05144390091300011, -0.007958423346281052, 0.02196330763399601, 0.02376447804272175, -0.04325929284095764, 0.026137545704841614, -0.0...
f26dfed3-6f90-48d8-9ddd-cd32add92172
For security, the service uses ClusterIP and is not exposed externally by default. To access the HyperDX UI, port forward from 3000 to the local port 8080. shell kubectl port-forward \ pod/$(kubectl get pod -l app.kubernetes.io/name=hdx-oss-v2 -o jsonpath='{.items[0].metadata.name}' -n otel-demo) \ 8080:3000 \...
{"source_file": "kubernetes.md"}
[ 0.03221796825528145, 0.00805643294006586, 0.01033611036837101, -0.05719703808426857, -0.09458551555871964, -0.014679876156151295, 0.03423386812210083, -0.03162924572825432, 0.01763724721968174, 0.019527927041053772, -0.004152190871536732, -0.07081366330385208, 0.03225778788328171, -0.05522...
ed84c7e9-ea0f-45cf-a844-6c00bc340a18
k8s_deployment.yaml deploys a single OpenTelemetry Collector instance responsible for collecting cluster-wide events and metadata . It gathers Kubernetes events, cluster metrics, and enriches telemetry data with pod labels and annotations. This collector runs as a standalone deployment with a single replica to avoi...
{"source_file": "kubernetes.md"}
[ 0.0005393511964939535, -0.005925596226006746, 0.03211681544780731, 0.0033533961977809668, -0.05037720873951912, -0.06706254184246063, 0.013193026185035706, -0.04210539162158966, 0.06647567451000214, 0.058691058307886124, 0.010620935820043087, -0.08164328336715698, -0.010074075311422348, -0...
25cd71cd-8720-4252-9581-6b0c0546f8c3
config: exporters: otlphttp: endpoint: "${env:YOUR_OTEL_COLLECTOR_ENDPOINT}" compression: gzip headers: authorization: "${env:HYPERDX_API_KEY}" service: pipelines: logs: exporters: - otlphttp metrics: exporters: - otlphttp ``` Nex...
{"source_file": "kubernetes.md"}
[ 0.00265447236597538, -0.017888784408569336, -0.02216586470603943, -0.035523295402526855, -0.04618553817272186, -0.05688555911183357, -0.024883046746253967, -0.03981976956129074, -0.006104267667979002, 0.022038334980607033, 0.052856601774692535, -0.08450571447610855, -0.04154209792613983, -...
36da808b-27d9-4bce-8651-7af878038e24
config: receivers: # Configures additional kubelet metrics kubeletstats: collection_interval: 20s auth_type: 'serviceAccount' endpoint: '${env:K8S_NODE_NAME}:10250' insecure_skip_verify: true metrics: k8s.pod.cpu_limit_utilization: enabled: true k8s.pod....
{"source_file": "kubernetes.md"}
[ 0.004344819113612175, 0.03479753062129021, -0.001310528488829732, 0.029923265799880028, -0.02077605202794075, -0.030243761837482452, -0.009139463305473328, -0.0336049422621727, 0.02962946891784668, 0.05168073624372482, 0.0011225888738408685, -0.06807328760623932, -0.03312099725008011, -0.0...
31f4518b-9477-4357-aa61-113f43299239
Using self-managed deployment To access the local deployed HyperDX, you can port forward using the local command and access HyperDX at [http://localhost:8080](http://localhost:8080). ```shell kubectl port-forward \ pod/$(kubectl get pod -l app.kubernetes.io/name=hdx-oss-v2 -o jsonpath='{.items[0].metadata.name}' -n...
{"source_file": "kubernetes.md"}
[ 0.040437113493680954, 0.020526695996522903, 0.05068407207727432, -0.07962898910045624, -0.06695151329040527, -0.046712301671504974, -0.019880421459674835, -0.07239799201488495, 0.022531986236572266, 0.0645701214671135, 0.02357330359518528, -0.07720121741294861, 0.0009777956875041127, -0.05...
d9914479-ffdc-4785-9451-0b57e1b9f874
slug: /use-cases/observability/clickstack/getting-started/sample-data title: 'Sample Logs, Traces and Metrics' sidebar_position: 0 pagination_prev: null pagination_next: null description: 'Getting started with ClickStack and a sample dataset with logs, sessions, traces and metrics' doc_type: 'guide' keywords: ['clickst...
{"source_file": "sample-data.md"}
[ 0.04790136590600014, -0.005281961522996426, -0.01371308509260416, -0.035058651119470596, -0.037105195224285126, -0.044369183480739594, 0.051061000674963, 0.017058659344911575, -0.10069521516561508, 0.029114345088601112, 0.07132010161876678, -0.021443285048007965, 0.06773054599761963, 0.014...
ed5abbed-41e8-441c-9a81-15a8bf3c8d2d
Visit http://localhost:8080 to access the HyperDX UI if deploying locally. If using HyperDX in ClickHouse Cloud, select your service and HyperDX from the left menu. Copy ingestion API key {#copy-ingestion-api-key} :::note HyperDX in ClickHouse Cloud This step is not required if using HyperDX in ClickHouse Clo...
{"source_file": "sample-data.md"}
[ 0.023435864597558975, 0.019439086318016052, 0.0036728184204548597, -0.017526572570204735, -0.015618064440786839, -0.05404326692223549, 0.029166264459490776, -0.04704698547720909, -0.039980314671993256, 0.010857826098799706, 0.05651763081550598, -0.07152827829122543, 0.05073748901486397, -0...
6a48b99b-3732-403a-a878-245860243d4f
Note that some sessions with emails have an associated error, potentially confirming reports of failed transactions. Select a trace with a failure and associated email. The subsequent view allows us to replay the user's session and review their issue. Press play to watch the session. The replay shows the user nav...
{"source_file": "sample-data.md"}
[ 0.0004880651831626892, 0.03402218222618103, 0.028796857222914696, -0.03281405195593834, 0.015875516459345818, -0.03330440819263458, 0.04726897552609444, -0.02485007606446743, 0.07695966958999634, 0.05808337405323982, -0.04730784147977829, 0.0844014436006546, -0.06098433956503868, 0.0315676...
c97520df-fb2c-42e3-ba4e-aaf642b0f901
slug: /use-cases/observability/clickstack/getting-started/local-data title: 'Local Logs & Metrics' sidebar_position: 1 pagination_prev: null pagination_next: null description: 'Getting started with ClickStack local and system data and metrics' doc_type: 'guide' keywords: ['clickstack', 'example data', 'sample dataset',...
{"source_file": "local-data.md"}
[ 0.046239420771598816, 0.012472630478441715, 0.0025010977406054735, -0.03394950553774834, -0.036937206983566284, -0.04407257214188576, 0.0418010838329792, 0.02926030382514, -0.10526881366968155, 0.03518572822213173, 0.07791076600551605, -0.004945539403706789, 0.07898508012294769, 0.02630755...
366749c2-a765-4688-b723-7ec5ba670e29
This configuration collects system logs and metrics for OSX and Linux systems, sending the results to ClickStack. The configuration extends the ClickStack collector by adding new receivers and pipelines—you reference the existing clickhouse exporter and processors ( memory_limiter , batch ) that are already configur...
{"source_file": "local-data.md"}
[ -0.05500958114862442, -0.046802207827568054, -0.027014924213290215, 0.019691621884703636, 0.02028299681842327, -0.09217336028814316, 0.0452222041785717, 0.002500685630366206, 0.07279288023710251, -0.0012959599262103438, 0.02930656261742115, -0.006942125502973795, -0.0253132414072752, -0.07...
6276c977-f298-43a3-889f-043c33ff9f9e
If using HyperDX in ClickHouse Cloud with a standalone collector, use this command instead: shell docker run -d \ -p 4317:4317 -p 4318:4318 \ --user 0:0 \ -e CUSTOM_OTELCOL_CONFIG_FILE=/etc/otelcol-contrib/custom.config.yaml \ -e OPAMP_SERVER_URL=${OPAMP_SERVER_URL} \ -e CLICKHOUSE_ENDPOINT=${CLICKHOUSE_END...
{"source_file": "local-data.md"}
[ 0.048526834696531296, 0.03262541815638542, -0.04083382338285446, -0.04456296190619469, -0.10043017566204071, -0.08474206924438477, 0.01663685031235218, -0.05839315801858902, -0.000010579151421552524, 0.034900397062301636, 0.06199159845709801, -0.10254581272602081, -0.028610438108444214, -0...
de801311-508c-4fa9-bb20-b1024c004e37
slug: /use-cases/observability/clickstack/sample-datasets title: 'Sample Datasets' pagination_prev: null pagination_next: null description: 'Getting started with ClickStack and sample datasets' doc_type: 'landing-page' keywords: ['ClickStack sample datasets', 'ClickStack demo data', 'observability sample data', 'ClickS...
{"source_file": "index.md"}
[ -0.015946444123983383, -0.08404825627803802, -0.035980723798274994, 0.02272304892539978, -0.008405792526900768, -0.08100011944770813, 0.00981935579329729, 0.007005359046161175, -0.0900181382894516, 0.05675961822271347, 0.010906653478741646, -0.07635913044214249, 0.0694909542798996, 0.01307...
40880254-65ef-4de3-b50e-9d126f9063e9
slug: /use-cases/observability/clickstack/getting-started/remote-demo-data title: 'Remote Demo Dataset' sidebar_position: 2 pagination_prev: null pagination_next: null description: 'Getting started with ClickStack and a remote demo dataset' doc_type: 'guide' keywords: ['clickstack', 'example data', 'sample dataset', 'l...
{"source_file": "remote-demo-data.md"}
[ 0.008911525830626488, -0.04383070021867752, -0.04903159290552139, 0.005941973067820072, 0.024368831887841225, -0.028284624218940735, -0.027522249147295952, 0.027175480499863625, -0.081070177257061, 0.040490057319402695, 0.08930488675832748, 0.00330051826313138, 0.07980642467737198, 0.01347...
a8e000a2-9181-478f-a108-db262c2dd744
import Image from '@theme/IdealImage'; import demo_connection from '@site/static/images/use-cases/observability/hyperdx-demo/demo_connection.png'; import edit_demo_connection from '@site/static/images/use-cases/observability/hyperdx-demo/edit_demo_connection.png'; import edit_demo_source from '@site/static/images/use-c...
{"source_file": "remote-demo-data.md"}
[ 0.0016490912530571222, 0.06861036270856857, -0.0013104462996125221, -0.027848968282341957, -0.003760523861274123, -0.033083848655223846, -0.03071339800953865, 0.05061214789748192, -0.07267479598522186, 0.017349913716316223, 0.07181578874588013, 0.01206622738391161, 0.08946556597948074, 0.0...
dce10649-0111-403b-a187-cf55a62c935c
The following guide assumes you have deployed ClickStack using the instructions for the all-in-one image , or Local Mode Only and completed initial user creation. Alternatively, users can skip all local setup and simply connect to our ClickStack hosted demo play-clickstack.clickhouse.com which uses this dataset. ...
{"source_file": "remote-demo-data.md"}
[ 0.04857461899518967, -0.07980962097644806, 0.03550230339169502, -0.008971402421593666, -0.024697255343198776, -0.027374999597668648, 0.03688463196158409, -0.06971757113933563, -0.04401761293411255, 0.02500130422413349, -0.0011165030300617218, -0.026189584285020828, 0.033869002014398575, -0...
1e7aaae4-0730-44ba-aaa8-e235ddfcf38a
::: Scroll up to Sources and modify each of the sources - Logs , Traces , Metrics , and Sessions - to use the otel_v2 database. :::note You may need to reload the page to ensure the full list of databases is listed in each source. ::: Adjust the time frame {#adjust-the-timeframe} Adjust the time to ...
{"source_file": "remote-demo-data.md"}
[ 0.08903899788856506, 0.004910654854029417, 0.046542029827833176, 0.034468431025743484, 0.017879189923405647, -0.014306746423244476, 0.023609526455402374, -0.026860404759645462, -0.022794421762228012, 0.003000353230163455, -0.03981359302997589, -0.05484792962670326, 0.038910191506147385, -0...
2a1f0c7c-5f4c-40da-9b53-c2db6751a438
Explore a trace {#explore-a-trace} In ClickStack, traces are also automatically correlated with both logs and metrics. Let's explore the trace linked to our selected log to identify the service responsible. Select Trace to visualize the associated trace. Scrolling down through the subsequent view we can see how H...
{"source_file": "remote-demo-data.md"}
[ -0.030631275847554207, -0.03893052414059639, 0.019009068608283997, -0.002632210962474346, -0.04585894197225571, -0.06947136670351028, 0.10089919716119766, -0.058356694877147675, 0.009777320548892021, 0.029648110270500183, 0.005194027442485094, -0.005700408481061459, -0.012168060056865215, ...
baa40eb9-db5a-4187-844d-5fe519824134
If we select the events with a duration greater than 200ms , and apply the filter Filter by selection , we can limit our analysis to slower events: With analysis performed on the subset of data, we can see most performance spikes are associated with visa transactions. Using charts for more context {#using-cha...
{"source_file": "remote-demo-data.md"}
[ 0.03695059195160866, -0.012336362153291702, -0.0016504222294315696, 0.0031243611592799425, 0.016346417367458344, -0.06043613702058792, 0.09476900845766068, -0.05123821273446083, 0.04626856744289398, 0.0025406714994460344, -0.012382037937641144, -0.03666843846440315, -0.040019385516643524, ...
b482895a-95ca-4017-938e-ed25037d5e5a
In HyperDX, sessions are linked to traces and logs, providing a complete view of the underlying cause. For example, if the support team provides the email of a user who encountered a payment issue Braulio.Roberts23@hotmail.com - it's often more effective to begin with their session rather than directly searching lo...
{"source_file": "remote-demo-data.md"}
[ -0.0018110194941982627, 0.02483747899532318, 0.052802979946136475, 0.02688673324882984, -0.006376861594617367, -0.007339385338127613, 0.10191433876752853, -0.08144956827163696, 0.041451845318078995, 0.003913321532309055, -0.07276596873998642, 0.0575854554772377, -0.0428992323577404, 0.0047...
65107499-1d8e-41a7-874b-c5af2413e3ba
slug: /use-cases/observability/clickstack/integrations/nginx title: 'Monitoring Nginx Logs with ClickStack' sidebar_label: 'Nginx Logs' pagination_prev: null pagination_next: null description: 'Monitoring Nginx with ClickStack' doc_type: 'guide' import Image from '@theme/IdealImage'; import useBaseUrl from '@docusa...
{"source_file": "nginx-logs.md"}
[ -0.0193549245595932, 0.002642968902364373, -0.012626870535314083, -0.009107851423323154, 0.054519928991794586, -0.0009852488292381167, 0.04645255208015442, 0.027739236131310463, -0.01876693405210972, 0.05160306766629219, -0.015966523438692093, -0.012836036272346973, 0.036961764097213745, 0...
aa0803ac-b051-4567-8d21-0c0d0e255da8
access_log /var/log/nginx/access.log json_combined; error_log /var/log/nginx/error.log warn; } ``` After making this change, reload Nginx. Create custom OTel collector configuration {#custom-otel} ClickStack allows you to extend the base OpenTelemetry Collector configuration by mounting a custom configuration ...
{"source_file": "nginx-logs.md"}
[ -0.029485110193490982, 0.045750200748443604, 0.021917158737778664, 0.007731996476650238, -0.05484050139784813, -0.12126234918832779, 0.02599342167377472, -0.020606281235814095, -0.02337273769080639, 0.031052155420184135, -0.00880621001124382, -0.07457169145345688, -0.049328431487083435, 0....
12088595-436a-4a52-89c8-e34b7f6cfeb9
Option 2: Docker Run (All-in-One Image) {#all-in-one} If using the all-in-one image with docker run: bash docker run --name clickstack \ -p 8080:8080 -p 4317:4317 -p 4318:4318 \ -e CUSTOM_OTELCOL_CONFIG_FILE=/etc/otelcol-contrib/custom.config.yaml \ -v "$(pwd)/nginx-monitoring.yaml:/etc/otelcol-contrib/custom....
{"source_file": "nginx-logs.md"}
[ 0.0478372797369957, 0.03398000821471214, -0.018095359206199646, -0.04855500906705856, 0.05990099534392357, -0.12134704738855362, 0.04006579518318176, -0.03608029708266258, -0.013662495650351048, 0.05954562500119209, 0.01405700296163559, -0.039589956402778625, 0.018615392968058586, 0.021874...
d4a740d5-2be9-4e18-86cb-b0616e8c766b
Once ClickStack is running (you may have to create an account and login first): Open HyperDX with demo time range Here's what you should see in your search view: :::note If you don't see logs, ensure the time range is set to 2025-10-20 11:00:00 - 2025-10-21 11:00:00 and 'Logs' is selected as the source. Usin...
{"source_file": "nginx-logs.md"}
[ -0.007406552322208881, -0.031704045832157135, -0.034095149487257004, 0.0029793318826705217, 0.03906838968396187, -0.03331196680665016, 0.006173789035528898, -0.03556413948535919, -0.017963236197829247, 0.05640239268541336, -0.04654037207365036, -0.038419485092163086, -0.01265502255409956, ...
61bce10f-9acc-4f41-bec9-3c842322e564
slug: /use-cases/observability/clickstack/integrations/redis-metrics title: 'Monitoring Redis Metrics with ClickStack' sidebar_label: 'Redis Metrics' pagination_prev: null pagination_next: null description: 'Monitoring Redis Metrics with ClickStack' doc_type: 'guide' keywords: ['Redis', 'metrics', 'OTEL', 'ClickStack']...
{"source_file": "redis-metrics.md"}
[ -0.02222258597612381, -0.0441628098487854, -0.08076320588588715, 0.024010255932807922, 0.02643635869026184, -0.029296331107616425, 0.07976263761520386, 0.062111228704452515, -0.004712889436632395, 0.0040555899031460285, 0.019324125722050667, -0.047989144921302795, 0.0911051481962204, 0.009...
4a3b3da9-4b14-4010-8efc-359c3afd612f
Create a file named redis-metrics.yaml with the following configuration: ```yaml title="redis-metrics.yaml" receivers: redis: endpoint: "localhost:6379" collection_interval: 10s # Uncomment if Redis requires authentication # password: ${env:REDIS_PASSWORD} # Configure which metrics to collect metr...
{"source_file": "redis-metrics.md"}
[ -0.03758827969431877, -0.070235975086689, -0.13197951018810272, 0.031114375218749046, -0.0545695535838604, -0.05300284922122955, 0.03032652847468853, -0.016780300065875053, 0.06491687148809433, 0.030024893581867218, 0.0035426428075879812, 0.004054104909300804, 0.024194102734327316, -0.0149...
c2d0da8a-fdb1-41a4-a665-064c43823bc3
Mount the custom config file at /etc/otelcol-contrib/custom.config.yaml Set the environment variable CUSTOM_OTELCOL_CONFIG_FILE=/etc/otelcol-contrib/custom.config.yaml Ensure network connectivity between ClickStack and Redis Option 1: Docker Compose {#docker-compose} Update your ClickStack deployment config...
{"source_file": "redis-metrics.md"}
[ -0.01699301041662693, -0.0684649869799614, -0.0345771498978138, -0.058153461664915085, -0.022640123963356018, -0.08835289627313614, 0.05301506444811821, -0.01574358530342579, 0.012925340794026852, -0.008059234358370304, 0.0057171606458723545, -0.06564042717218399, 0.043080639094114304, 0.0...