Merge branch 'hotfix-1.10.x' into hotfix-2.1.x

gentics · Aug 7, 2024 · 554d8db · 554d8db
2 parents 73d55ab + e29f97b
commit 554d8db
Show file tree

Hide file tree

Showing 10 changed files with 117 additions and 9 deletions.
diff --git a/LTS-CHANGELOG.adoc b/LTS-CHANGELOG.adoc
@@ -17,6 +17,10 @@ include::content/docs/variables.adoc-include[]
 The LTS changelog lists releases which are only accessible via a commercial subscription.
 All fixes and changes in LTS releases will be released the next minor release. Changes from LTS 1.4.x will be included in release 1.5.0.
 
+[[v1.10.32]]
+== 1.10.32 (07.08.2024)
+
+icon:check[] Documentation: The check/repair API calls are better documented in regards of an async processing. The logging documentation is extended with format examples.
 
 [[v1.10.31]]
 == 1.10.31 (26.06.2024)

diff --git a/api/src/main/java/com/gentics/mesh/etc/config/DebugInfoOptions.java b/api/src/main/java/com/gentics/mesh/etc/config/DebugInfoOptions.java
@@ -33,7 +33,7 @@ public class DebugInfoOptions implements Option {
 	private boolean logEnabled = true;
 
 	@JsonProperty(required = false)
-	@JsonPropertyDescription("The pattern used for each log line.")
+	@JsonPropertyDescription("The pattern used for each log line. For the detailed pattern format description please refer to the link:https://logback.qos.ch/manual/layouts.html#conversionWord[Logback documentation]. Default value is: " + DEFAULT_LOG_PATTERN)
 	@EnvironmentVariable(name = "MESH_DEBUGINFO_LOG_PATTERN", description = "Override the log pattern")
 	private String logPattern = DEFAULT_LOG_PATTERN;
 

diff --git a/changelog/src/changelog/entries/2024/08/7922.SUP-17105.bugfix b/changelog/src/changelog/entries/2024/08/7922.SUP-17105.bugfix
@@ -0,0 +1 @@
+Documentation: The check/repair API calls are better documented in regards of an async processing. The logging documentation is extended with format examples.
diff --git a/core/src/main/java/com/gentics/mesh/core/endpoint/admin/AdminEndpoint.java b/core/src/main/java/com/gentics/mesh/core/endpoint/admin/AdminEndpoint.java
@@ -220,7 +220,9 @@ private void addConsistencyCheckHandler() {
 		endpoint.path("/consistency/check");
 		endpoint.method(GET);
 		endpoint.description(
-			"Invokes a consistency check of the graph database without attempting to repairing the found issues. A list of found issues will be returned.");
+			"Invokes a consistency check of the graph database without attempting to repairing the found issues. A list of found issues will be returned. "
+					+ "When an `async=true` query parameter is used, a new consistency check Job is queued, and the check results should be obtained with the call to the link:#admin_jobs__jobUuid__get[corresponding job]."
+					+ "Please note that some checks do require an `async` flag set.");
 		endpoint.produces(APPLICATION_JSON);
 		endpoint.exampleResponse(OK, adminExamples.createConsistencyCheckResponse(false), "Consistency check report");
 		endpoint.addQueryParameters(ConsistencyCheckParametersImpl.class);
@@ -232,7 +234,9 @@ private void addConsistencyCheckHandler() {
 		repairEndpoint.path("/consistency/repair");
 		repairEndpoint.method(POST);
 		repairEndpoint
-			.description("Invokes a consistency check and repair of the graph database and returns a list of found issues and their state.");
+			.description("Invokes a consistency check and repair of the graph database and returns a list of found issues and their state. "
+					+ "When an `async=true` query parameter is used, a new consistency repair Job is queued, and the repair results should be obtained with the call to the link:#admin_jobs__jobUuid__get[corresponding job]. "
+					+ "Please note that some repairs do require an `async` flag set.");
 		repairEndpoint.produces(APPLICATION_JSON);
 		repairEndpoint.exampleResponse(OK, adminExamples.createConsistencyCheckResponse(true), "Consistency check and repair report");
 		repairEndpoint.events(REPAIR_START, REPAIR_FINISHED);

diff --git a/doc/src/main/docs/generated/tables/ConsistencyCheckParametersImpl.adoc-include b/doc/src/main/docs/generated/tables/ConsistencyCheckParametersImpl.adoc-include
@@ -10,6 +10,6 @@
 | async
 | boolean  (default: false) 
 | false
-| Specifiy whether the consistency check should be executed asynchronously (as job).
+| Specifiy whether the consistency check should be executed asynchronously (as job). *Please note that some checks do require this flag set!*
 
 |======
diff --git a/doc/src/main/docs/generated/tables/DebugInfoOptions.adoc-include b/doc/src/main/docs/generated/tables/DebugInfoOptions.adoc-include
@@ -25,6 +25,6 @@
 | logPattern
 | false
 | string
-| The pattern used for each log line.
+| The pattern used for each log line. For the detailed pattern format description please refer to the link:https://logback.qos.ch/manual/layouts.html#conversionWord[Logback documentation]. Default value is: %d{HH:mm:ss.SSS} [%meshName] %-5level [%thread] [%file:%line] - %msg%n
 
 |======
diff --git a/doc/src/main/docs/generated/tables/GenericRestResponse.adoc-include b/doc/src/main/docs/generated/tables/GenericRestResponse.adoc-include
@@ -7,17 +7,17 @@
 | Description
 
 
-| editor.firstName
+| creator.firstName
 | false
 | string
 | Firstname of the user
 
-| editor.lastName
+| creator.lastName
 | false
 | string
 | Lastname of the user
 
-| editor.uuid
+| creator.uuid
 | true
 | string
 | Uuid of the user

diff --git a/doc/src/main/docs/generated/tables/GraphDBMeshOptions.adoc-include b/doc/src/main/docs/generated/tables/GraphDBMeshOptions.adoc-include
@@ -0,0 +1,85 @@
+[options="header",cols="10%,10%,10%,70%"]
+|======
+
+| Property
+| Mandatory 
+| Type
+| Description
+
+
+| storageOptions.nativeQueryFiltering
+| false
+| nativequeryfiltering
+| Enables the experimental native database level filtering for queries. Default: NEVER
+
+| storageOptions.directory
+| true
+| string
+| Path to the graph database data directory.
+
+| storageOptions.backupDirectory
+| true
+| string
+| Path to the graph database backup directory.
+
+| storageOptions.exportDirectory
+| true
+| string
+| Path to the graph database export directory.
+
+| storageOptions.startServer
+| true
+| boolean
+| Flag which indicates whether the graph database admin web server should be started. Default: false
+
+| storageOptions.synchronizeWrites
+| true
+| boolean
+| Flag which controls whether writes to the graph database should be synchronized. Default: true
+
+| storageOptions.synchronizeWritesTimeout
+| true
+| long
+| Set the timeout in milliseconds for the sync write lock. Default: 60000
+
+| storageOptions.txRetryDelay
+| false
+| int
+| The delay in milliseconds when a transaction has to be retried.
+
+| storageOptions.txRetryLimit
+| false
+| int
+| The limit for the tx retires.
+
+| storageOptions.txCommitTimeout
+| false
+| long
+| The transaction commit timeout in milliseconds. A timeout value of zero means that transaction commit operations will never timeout.
+
+| storageOptions.parameters
+| false
+| map
+| Additional set of graph database parameters.
+
+| storageOptions.clusterJoinTimeout
+| false
+| int
+| The timeout for joining the graphdb cluster in milliseconds. This also includes the time it takes to synchronize the graphdb over the network.
+
+| diskQuota.checkInterval
+| false
+| int
+| Check interval in ms. Setting this to 0 will disable the disk quota check. Default: 10000
+
+| diskQuota.warnThreshold
+| false
+| string
+| Threshold for the disk quota warn level. This can be set either as percentage (e.g. 15%) or as absolute disk space (e.g. 10G). If less than the defined disk space is available, warnings will be logged. Default: 3G
+
+| diskQuota.readOnlyThreshold
+| false
+| string
+| Threshold for the disk quota ready only level. This can be set either as percentage (e.g. 10%) or as absolute disk space (e.g. 5G). If less than the defined disk space is available, Mesh will automatically be set to readonly. Default: 1G
+
+|======
diff --git a/doc/src/main/docs/logging.asciidoc b/doc/src/main/docs/logging.asciidoc
@@ -26,6 +26,20 @@ Possible values: `ERROR`, `WARN`, `INFO`, `TRACE`, `DEBUG`
 
 Logging levels `TRACE` and `DEBUG` should only turned on for specific classes. Those levels will cause excessive log output.
 
+[[format]]
+== Format
+
+For the detailed pattern format description please refer to the link:https://logback.qos.ch/manual/layouts.html#conversionWord[Logback documentation]. Below are some basic formatting tips:
+
+[width="100%",cols="15%,35%,25%,25%",options="header",]
+|===
+| Formatter | Description | Input | Result
+| %logger{4} | Logger name, with the topmost 4 path names abbreviated | com.gentics.mesh.server.Server | c.g.m.s.Server 
+| %date{dd MMM yyyy;HH:mm:ss.SSS} | Date formatter | 2025-01-23 00:45:11,812 | 23 jan. 2025;00:45:11.812 
+| %meshName | Mesh instance name | <Generated by Mesh or set through Mesh Options> | Gentics Mesh
+| %thread | Thread name | Thread-1 | Thread-1
+|===
+
 [[examples]]
 == Examples
 

diff --git a/mdm/api/src/main/java/com/gentics/mesh/parameter/impl/ConsistencyCheckParametersImpl.java b/mdm/api/src/main/java/com/gentics/mesh/parameter/impl/ConsistencyCheckParametersImpl.java
@@ -35,7 +35,7 @@ public ConsistencyCheckParametersImpl() {
 		// async
 		QueryParameter asyncParameter = new QueryParameter();
 		asyncParameter.setDefaultValue("false");
-		asyncParameter.setDescription("Specifiy whether the consistency check should be executed asynchronously (as job).");
+		asyncParameter.setDescription("Specifiy whether the consistency check should be executed asynchronously (as job). *Please note that some checks do require this flag set!*");
 		asyncParameter.setExample("true");
 		asyncParameter.setRequired(false);
 		asyncParameter.setType(ParamType.BOOLEAN);
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Documentation: The check/repair API calls are better documented in regards of an async processing. The logging documentation is extended with format examples.