Skip to content

Commit

Permalink
Merge pull request #301 from gramian/main
Browse files Browse the repository at this point in the history
25.1.1 Updates
  • Loading branch information
lvca authored Jan 26, 2025
2 parents 35a1d1c + 2ad1f38 commit 8703a5e
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 8 deletions.
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

<groupId>com.arcadedb</groupId>
<artifactId>arcadedb-doc</artifactId>
<version>23.10.1</version>
<version>25.1.1</version>
<packaging>war</packaging>

<properties>
Expand Down
14 changes: 8 additions & 6 deletions src/main/asciidoc/appendix/settings.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,6 @@ If you're embedding a server in your Java application you can use these settings
|`server.httpsIncomingPort`|TCP/IP port number used for incoming HTTPS connections. Specify a single port or a range `<from>-<to>`. Default is 2490-2499 to accept a range of ports in case they are occupied.|String|2490-2499
|`server.httpsIoThreads`|Number of threads to use in the HTTP server|Integer|2 per core
|`server.httpTxExpireTimeout`|Timeout in seconds for a HTTP transaction to expire. This timeout is computed from the latest command against the transaction|Long|30
|`serverMetrics`|True to enable metrics|Boolean|true
|`server.mode`|Server mode between 'development', 'test' and 'production'|String|development
|`server.name`|Server name|String|ArcadeDB_0
|`server.plugins`|Server plugins to load, see <<#_available-plugins,available plugins>>. Format as comma separated list of: `<pluginName>:<pluginFullClass>`.|String|
Expand All @@ -147,6 +146,8 @@ If you're embedding a server in your Java application you can use these settings
|`server.securitySaltCacheSize`|Cache size of hashed salt passwords. The cache works as LRU. Use 0 to disable the cache|Integer|64
|`server.saltIterations`|Number of iterations to generate the salt or user password. Changing this setting does not affect stored passwords|Integer|65536
|`server.eventBusQueueSize`|Size of the queue used as a buffer for unserviced database change events.|Integer|1000
|`serverMetrics`|True to enable metrics|Boolean|true
|`serverMetrics.logging`|True to enable metrics logging|Boolean|true
|===

===== DATABASE
Expand Down Expand Up @@ -188,10 +189,11 @@ If you're embedding a server in your Java application you can use these settings

[%header,cols="2",stripes=even]
|===
| Name | `server.plugins`-String
| Gremlin | `GremlinServer:com.arcadedb.server.gremlin.GremlinServerPlugin`
| MongoDB | `MongoDB:com.arcadedb.mongo.MongoDBProtocolPlugin`
| Postgres | `Postgres:com.arcadedb.postgres.PostgresProtocolPlugin`
| Redis | `Redis:com.arcadedb.redis.RedisProtocolPlugin`
| Name | `server.plugins`-String
| Gremlin | `GremlinServer:com.arcadedb.server.gremlin.GremlinServerPlugin`
| MongoDB | `MongoDB:com.arcadedb.mongo.MongoDBProtocolPlugin`
| Postgres | `Postgres:com.arcadedb.postgres.PostgresProtocolPlugin`
| Prometheus | `Prometheus:com.arcadedb.metrics.prometheus.PrometheusMetricsPlugin`
| Redis | `Redis:com.arcadedb.redis.RedisProtocolPlugin`
|===

25 changes: 25 additions & 0 deletions src/main/asciidoc/server/server.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -255,3 +255,28 @@ $ java ... -Darcadedb.server.plugins=MyPlugin:com.yourpackage.MyPlugin ...
----

In case of multiple plugins, use the comma to separate them.


==== Metrics

The ArcadeDB server can collect, log and publish metrics.
To activate the collection of metrics use the setting:
[source,shell]
----
$ ... -Darcadedb.serverMetrics=true
----

To log the metrics to the standard output use the setting:
[source,shell]
----
$ ... -Darcadedb.serverMetrics.logging=true
----

To publish the metrics in the https://prometheus.io[Prometheus] via HTTP, add the plugin:
[source,shell]
----
$ ... -Darcadedb.server.plugins="Prometheus:com.arcadedb.metrics.prometheus.PrometheusMetricsPlugin"
----

Then, under `\http://localhost:2480/prometheus` (or the respective ArcadeDB host) the metrics can be requested given server credentials.
For details about the response format see the https://prometheus.io/docs/instrumenting/exposition_formats/[Prometheus docs].
1 change: 1 addition & 0 deletions src/main/asciidoc/sql/SQL-Import-Database.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ be imported. The importer automatically recognize the file between the following
GraphML is recommended
* *GraphSON* database export
* *JSON* documents or responses
* *JSON Lines* documents or responses

*Syntax*

Expand Down
1 change: 1 addition & 0 deletions src/main/asciidoc/tools/importer.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ ArcadeDB provides some basic ETL capabilities for automatically importing datase
- https://github.com/tinkerpop/blueprints/wiki/GraphSON-Reader-and-Writer-Library[GraphSON] database export
- Generic XML files
- Generic <<JSON-Importer,JSON>> files
- Generic JSONL files
- Generic CSV files
- Generic RDF files

Expand Down
2 changes: 1 addition & 1 deletion src/main/asciidoc/version.adoc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
:revnumber: 24.11.2
:revnumber: 25.1.1

0 comments on commit 8703a5e

Please sign in to comment.