Skip to content
This repository was archived by the owner on Mar 24, 2024. It is now read-only.

Commit f9b257a

Browse files
ThatsNoMoonThatsNoMoon
committed
add cassandra setup container
Added a new container to set up Cassandra for Jaeger logs, especially to make docker-compose more seamless.
1 parent 8a28229 commit f9b257a

7 files changed

Lines changed: 556 additions & 16 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ For self-hosters, highlights includes:
1616
- Performance monitoring and observability with [Jaeger](https://jaegertracing.io/)
1717

1818
## Docker
19-
You can find a Dockerfile in this repository, or use [`thatsnomoon/highlights`](https://hub.docker.com/r/thatsnomoon/highlights). Also provided is a `docker-compose.yml` that will organize Highlights, a Jaeger agent, collector, and query server, and Cassandra, though for the time being you'll have to set up Cassandra to store Jaeger logs yourself.
19+
You can find a Dockerfile in this repository, or use [`thatsnomoon/highlights`](https://hub.docker.com/r/thatsnomoon/highlights). Also provided is a `docker-compose.yml` that will organize Highlights, a Jaeger agent, collector, and query server, and Cassandra, and should set up Cassandra to accept Jaeger logs.
2020

2121
## Download
2222
You can find downloads for 64 bit Windows and Linux, as well as 64 bit Linux ARM (for e.g. Raspberry Pi) on [the releases page](https://github.com/ThatsNoMoon/highlights/releases/).

‎docker-compose.yml‎

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,17 @@ services:
1313
depends_on:
1414
jaeger-agent:
1515
condition: service_started
16+
restart: unless-stopped
1617

1718
jaeger-agent:
1819
image: jaegertracing/jaeger-agent:1.34
1920
networks:
2021
- net
2122
command: "--reporter.grpc.host-port=jaeger-collector:14250"
22-
healthcheck:
23-
test: ["CMD", "curl", "localhost:14271"]
24-
interval: 30s
25-
timeout: 10s
2623
depends_on:
2724
jaeger-collector:
2825
condition: service_started
26+
restart: unless-stopped
2927

3028
jaeger-collector:
3129
image: jaegertracing/jaeger-collector:1.34
@@ -34,13 +32,11 @@ services:
3432
environment:
3533
SPAN_STORAGE_TYPE: "cassandra"
3634
CASSANDRA_SERVERS: "cassandra"
37-
healthcheck:
38-
test: ["CMD", "curl", "localhost:14269"]
39-
interval: 30s
40-
timeout: 10s
35+
CASSANDRA_KEYSPACE: "jaeger_v1_dc1"
4136
depends_on:
42-
cassandra:
43-
condition: service_healthy
37+
cassandra-setup:
38+
condition: service_completed_successfully
39+
restart: unless-stopped
4440

4541
jaeger-query:
4642
image: jaegertracing/jaeger-query:1.34
@@ -51,10 +47,20 @@ services:
5147
environment:
5248
SPAN_STORAGE_TYPE: "cassandra"
5349
CASSANDRA_SERVERS: "cassandra"
54-
healthcheck:
55-
test: ["CMD", "curl", "localhost:16687"]
56-
interval: 30s
57-
timeout: 10s
50+
CASSANDRA_KEYSPACE: "jaeger_v1_dc1"
51+
depends_on:
52+
cassandra-setup:
53+
condition: service_completed_successfully
54+
restart: unless-stopped
55+
56+
cassandra-setup:
57+
image: thatsnomoon/highlights-jaeger-cassandra-setup:1.0.0
58+
networks:
59+
- net
60+
environment:
61+
MODE: "prod"
62+
DATACENTER: "dc1"
63+
REPLICATION_FACTOR: 1
5864
depends_on:
5965
cassandra:
6066
condition: service_healthy
@@ -66,9 +72,10 @@ services:
6672
volumes:
6773
- "cassandra-data:/opt/cassandra/data"
6874
healthcheck:
69-
test: ["CMD", "cqlsh", "-e", "use jaeger_v1_test;"]
75+
test: ["CMD", "cqlsh", "-e", "show version;"]
7076
interval: 30s
7177
timeout: 10s
78+
restart: unless-stopped
7279

7380

7481
secrets:

‎jaeger-db-setup/APACHE_LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎jaeger-db-setup/Dockerfile‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
FROM cassandra:4.0
2+
3+
WORKDIR /scripts
4+
5+
COPY ["create.sh", "v004.cql.tmpl", "./"]
6+
7+
CMD ["/scripts/create.sh"]

‎jaeger-db-setup/README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Jaeger DB Setup Image
2+
This is a simple Dockerfile for an image to set up a Cassandra 4.0 database for Jaeger.
3+
4+
You may be able to use [`jaegertracing/jaeger-cassandra-schema`](https://hub.docker.com/r/jaegertracing/jaeger-cassandra-schema), but I had problems using it with Cassandra 4.0, and problems using Cassandra 3.11 with Jaeger.
5+
6+
### License
7+
The scripts in this folder, `create.sh` and `v004.cql.tmpl`, are adapted from those in [the Jaeger repository](https://github.com/jaegertracing/jaeger/tree/4f9f7dfa7ea3e5346679a1a045a6cd346a061870/plugin/storage/cassandra/schema), and are thus licensed under the Apache 2.0 license.

‎jaeger-db-setup/create.sh‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
#!/usr/bin/env bash
2+
3+
# Copyright 2021 Jaeger authors, 2022 ThatsNoMoon
4+
#
5+
# Licensed under the Apache License, Version 2.0 (the "License");
6+
# you may not use this file except in compliance with the License.
7+
# You may obtain a copy of the License at
8+
#
9+
# http://www.apache.org/licenses/LICENSE-2.0
10+
#
11+
# Unless required by applicable law or agreed to in writing, software
12+
# distributed under the License is distributed on an "AS IS" BASIS,
13+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
# See the License for the specific language governing permissions and
15+
# limitations under the License.
16+
17+
function usage {
18+
>&2 echo "Error: $1"
19+
>&2 echo ""
20+
>&2 echo "The following parameters can be set via environment:"
21+
>&2 echo " MODE - prod or test. Test keyspace is usable on a single node cluster (no replication)"
22+
>&2 echo " CASSANDRA - hostname of cassandra (default: cassandra)"
23+
>&2 echo " DATACENTER - datacenter name for network topology used in prod (optional in MODE=test)"
24+
>&2 echo " TRACE_TTL - time to live for trace data, in seconds (default: 172800, 2 days)"
25+
>&2 echo " DEPENDENCIES_TTL - time to live for dependencies data, in seconds (default: 0, no TTL)"
26+
>&2 echo " KEYSPACE - keyspace (default: jaeger_v1_{datacenter})"
27+
>&2 echo " REPLICATION_FACTOR - replication factor for prod (default: 2 for prod, 1 for test)"
28+
exit 1
29+
}
30+
31+
trace_ttl=${TRACE_TTL:-172800}
32+
dependencies_ttl=${DEPENDENCIES_TTL:-0}
33+
cassandra=${CASSANDRA:-cassandra}
34+
35+
template=${1:-v004.cql.tmpl}
36+
37+
if [[ "$MODE" == "" ]]; then
38+
usage "missing MODE parameter"
39+
elif [[ "$MODE" == "prod" ]]; then
40+
if [[ "$DATACENTER" == "" ]]; then usage "missing DATACENTER parameter for prod mode"; fi
41+
datacenter=$DATACENTER
42+
replication_factor=${REPLICATION_FACTOR:-2}
43+
elif [[ "$MODE" == "test" ]]; then
44+
datacenter=${DATACENTER:-'test'}
45+
replication_factor=${REPLICATION_FACTOR:-1}
46+
else
47+
usage "invalid MODE=$MODE, expecting 'prod' or 'test'"
48+
fi
49+
50+
replication="{'class': 'SimpleStrategy', 'replication_factor': '${replication_factor}'}"
51+
keyspace=${KEYSPACE:-"jaeger_v1_${datacenter}"}
52+
53+
if [[ $keyspace =~ [^a-zA-Z0-9_] ]]; then
54+
usage "invalid characters in KEYSPACE=$keyspace parameter, please use letters, digits or underscores"
55+
fi
56+
57+
if cqlsh -e "use $keyspace;" $cassandra 2> /dev/null; then
58+
echo "$keyspace already exists. nothing to do."
59+
exit 0
60+
fi
61+
62+
>&2 cat <<EOF
63+
Using template file $template with parameters:
64+
mode = $MODE
65+
cassandra = $cassandra
66+
datacenter = $datacenter
67+
keyspace = $keyspace
68+
replication = ${replication}
69+
trace_ttl = ${trace_ttl}
70+
dependencies_ttl = ${dependencies_ttl}
71+
EOF
72+
73+
# strip out comments, collapse multiple adjacent empty lines (cat -s), substitute variables
74+
cat $template | sed \
75+
-e 's/--.*$//g' \
76+
-e 's/^\s*$//g' \
77+
-e "s/\${keyspace}/${keyspace}/g" \
78+
-e "s/\${replication}/${replication}/g" \
79+
-e "s/\${trace_ttl}/${trace_ttl}/g" \
80+
-e "s/\${dependencies_ttl}/${dependencies_ttl}/g" \
81+
| cat -s \
82+
| cqlsh $cassandra

0 commit comments

Comments
 (0)