Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mikeblum/xk6-neo4j
Grafana K6 Extension for profiling Neo4j - a graph datadase
https://github.com/mikeblum/xk6-neo4j
k6 k6-extension xk6 xk6-extension
Last synced: about 2 months ago
JSON representation
Grafana K6 Extension for profiling Neo4j - a graph datadase
- Host: GitHub
- URL: https://github.com/mikeblum/xk6-neo4j
- Owner: mikeblum
- License: apache-2.0
- Created: 2022-06-20T04:49:01.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-23T09:54:51.000Z (over 1 year ago)
- Last Synced: 2024-06-20T00:28:35.528Z (3 months ago)
- Topics: k6, k6-extension, xk6, xk6-extension
- Language: Go
- Homepage:
- Size: 84 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# xk6-neo4j
A [k6](https://k6.io/) extension for [Neo4j](https://neo4j.com/) - a graph database
---
## Legal
[](https://opensource.org/licenses/Apache-2.0)
## Development
Supported Neo4j [versions](https://neo4j.com/developer/kb/neo4j-supported-versions/):
| Neo4j Version | Edition |
| ------------- | ------------- |
| Neo4j 4.4.x | Community |
### From Source
- go 1.17+
- k6 v0.38.3
- xk6 v0.7.0
- neo4j community 4.4.x
- openjdk 11
1\. Install Go 1.17+ < 1.18:
> Go 1.18.x breaks a number of libraries; atm `k6` builds with 1.17.9
2\. Install `xk6` for building custom K6 binaries:
`go install go.k6.io/xk6/cmd/xk6@latest`
3\. Install [https://golangci-lint.run/usage/install/](https://golangci-lint.run/usage/install/):
`go install github.com/golangci/golangci-lint/cmd/[email protected]`
4\. Install [Neo4j community edition](https://neo4j.com/download-center/):
`wget https://dist.neo4j.org/neo4j-community-4.4.8-unix.tar.gz`
5\. Configure Prometheus Metrics for Neo4j
[How to monitor Neo4j with Prometheus](https://neo4j.com/developer/kb/how-to-monitor-neo4j-with-prometheus/)
`neo4j.conf`
```
# Bolt connector
dbms.connector.bolt.enabled=true
dbms.connector.bolt.tls_level=DISABLED
# bind to 0.0.0.0 when using WSL otherwise localhost
dbms.connector.bolt.listen_address=0.0.0.0:7687
dbms.connector.bolt.advertised_address=:7687
# HTTP Connector. There can be zero or one HTTP connectors.
dbms.connector.http.enabled=true
# bind to 0.0.0.0 when using WSL otherwise localhost
dbms.connector.http.listen_address=0.0.0.0:7474
dbms.connector.http.advertised_address=:7474
# Enable the Prometheus endpoint. Default is 'false'.
metrics.prometheus.enabled=true
# The IP and port the endpoint will bind to in the format :.
# The default is localhost:2004.
# bind to 0.0.0.0 when using WSL otherwise localhost
metrics.prometheus.endpoint=0.0.0.0:2004
```
❗ Don't bind to `0.0.0.0` on a VPS like Digital Ocean or EC2!
> Be sure to restart the neo4j proc for your changes to take effect
`prometheus.yml`
```
# A scrape configuration containing exactly one endpoint to scrape:
# Here it's Prometheus itself.
scrape_configs:
- job_name: 'neo4j-prometheus'
# metrics_path: /metrics
# scheme defaults to 'http'.
static_configs:
- targets: ['localhost:2004']
```
6\. Install OpenJDK 11 [Neo4j dep]
```
java --version
openjdk 11.0.15 2022-04-19
OpenJDK Runtime Environment Temurin-11.0.15+10 (build 11.0.15+10)
OpenJDK 64-Bit Server VM Temurin-11.0.15+10 (build 11.0.15+10, mixed mode)
```
7\. Start Neo4j
`/usr/local/neo4j/bin/neo4j start`
8\. Raise the `ulimit` if you encounter:
> WARNING: Max 4096 open files allowed, minimum of 40000 recommended. See the Neo4j manual.
https://neo4j.com/developer/kb/number-of-open-files-on-linux/
❗ `ulimit` on WSL is tricky: https://github.com/microsoft/WSL/discussions/6226
WSL for Windows
Add the following to the top of your `~/.zshrc`:
```
# https://github.com/microsoft/WSL/discussions/6226
ULIMIT=65536
if [[ "$(ulimit -n)" != $ULIMIT ]]; then
sudo prlimit --nofile=$ULIMIT:$ULIMIT --pid $$
exec /bin/zsh
fi
```
then run the following:
```
source ~/.zshrc
ulimit -n
```
should return `$ULIMIT`
Restart `neo4j` once more and the warning should resolve:
```
./bin/neo4j restart
Neo4j is not running.
Directories in use:
home: /usr/local/neo4j
config: /usr/local/neo4j/conf
logs: /usr/local/neo4j/logs
plugins: /usr/local/neo4j/plugins
import: /usr/local/neo4j/import
data: /usr/local/neo4j/data
certificates: /usr/local/neo4j/certificates
licenses: /usr/local/neo4j/licenses
run: /usr/local/neo4j/run
Starting Neo4j.
Started neo4j (pid:1324). It is available at http://localhost:7474
There may be a short delay until the server is ready.
```
❗ Note you'll need to change the default `neo4j` password:
[Set an initial password](https://neo4j.com/docs/operations-manual/current/configuration/set-initial-password/)
or browse to `http://localhost:7474`
> 🍴 forked from [grafana/xk6-sql](https://github.com/grafana/xk6-sql)