You are viewing a plain text version of this content. The canonical link for it is here.
Posted to pr@cassandra.apache.org by "neshkeev (via GitHub)" <gi...@apache.org> on 2023/01/23 10:05:50 UTC
[GitHub] [cassandra] neshkeev opened a new pull request, #2062: CASSANDRA-18185 Accumulate all `docs` PR
neshkeev opened a new pull request, #2062:
URL: https://github.com/apache/cassandra/pull/2062
I searched the entire repository for the `*.md` files and didn't spot any more of such typos.
Here is the command:
```bash
find . -not -path "./.git/*" -type f -name "*.md" -exec grep --color "\(\b\w\+\)\b\s*\1\b" {} \+
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on a diff in pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on code in PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#discussion_r1083771569
##########
src/java/org/apache/cassandra/service/StartupChecks.java:
##########
@@ -226,7 +226,7 @@ public void execute(StartupChecksOptions options)
public static final StartupCheck checkValidLaunchDate = new StartupCheck()
{
/**
- * The earliest legit timestamp a casandra instance could have ever launched.
+ * The earliest legit timestamp a cassandra instance could have ever launched.
Review Comment:
`cassandra` -> `Cassandra`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] michaelsembwever commented on pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "michaelsembwever (via GitHub)" <gi...@apache.org>.
michaelsembwever commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1399536945
Generally LGTM.
But…
A more descriptive commit message please.
"Accumulate all docs PR" means nothing to me.
Something like "Accumulation of small typo fixes to docs" would be much better. Folk need to scan git history quickly.
I'm also not sure about the changes to hyphenation (coming [from this PR|https://github.com/apache/cassandra/pull/567/]). For example "open-source" just reads wrong to me (even when it's used as an adjective. The overall change to using hyphenation might need broader agreement. Personally I would just leave it out to move ahead with the other changes.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] neshkeev commented on pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "neshkeev (via GitHub)" <gi...@apache.org>.
neshkeev commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1399541598
Those hyphenated adjectives looked odd to me too, when I was in doubt, I googled them, for example, [open-source databases](https://phoenixnap.com/kb/open-source-database), or [5-node cluster](https://www.servethehome.com/building-5-node-proxmox-ve-cluster-20-minutes-dollar-phoenixnap-intel-supermicro/)
I agree with you, we need more input on this from the community to find out the best possible phrasing
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] Mmuzaf commented on pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "Mmuzaf (via GitHub)" <gi...@apache.org>.
Mmuzaf commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1403795392
@neshkeev Please, consider the following typo fixes.
https://github.com/Mmuzaf/cassandra/commit/94452527b9a3f963871a5839af5e841b4e21af76
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1403291077
@neshkeev could you please cherry-pick this?
https://github.com/instaclustr/cassandra/commit/20194117b5371d8e9d6f0673bb0a685262dc739e
I think we are in quite a good shape, I ll try to find somebody else to take a look too.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on a diff in pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on code in PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#discussion_r1083767051
##########
doc/modules/cassandra/pages/architecture/guarantees.adoc:
##########
@@ -1,17 +1,21 @@
= Guarantees
Apache Cassandra is a highly scalable and reliable database. Cassandra
-is used in web based applications that serve large number of clients and
+<<<<<<< HEAD
Review Comment:
@neshkeev this seems like conflicts were not resolved properly.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on a diff in pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on code in PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#discussion_r1083766431
##########
conf/cqlshrc.sample:
##########
@@ -33,6 +32,10 @@
; classname = PlainTextAuthProvider
; username = user1
+[protocol]
Review Comment:
@neshkeev is this really relevant? can you point me to the PR suggesting to add this?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on a diff in pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on code in PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#discussion_r1083767321
##########
doc/modules/cassandra/pages/architecture/guarantees.adoc:
##########
@@ -47,46 +51,50 @@ Cassandra makes the following guarantees.
* Batched writes across multiple tables are guaranteed to succeed
completely or not at all
* Secondary indexes are guaranteed to be consistent with their local
-replicas data
+replicas' data
== High Scalability
Cassandra is a highly scalable storage system in which nodes may be
-added/removed as needed. Using gossip-based protocol a unified and
+added/removed as needed. Using gossip-based protocol, a unified and
consistent membership list is kept at each node.
== High Availability
Cassandra guarantees high availability of data by implementing a
-fault-tolerant storage system. Failure detection in a node is detected
-using a gossip-based protocol.
+fault-tolerant storage system. Failure of a node is detected using
+a gossip-based protocol.
== Durability
Cassandra guarantees data durability by using replicas. Replicas are
multiple copies of a data stored on different nodes in a cluster. In a
multi-datacenter environment the replicas may be stored on different
datacenters. If one replica is lost due to unrecoverable node/datacenter
-failure the data is not completely lost as replicas are still available.
+<<<<<<< HEAD
Review Comment:
@neshkeev not resolved conflicts
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] neshkeev commented on pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "neshkeev (via GitHub)" <gi...@apache.org>.
neshkeev commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1399507105
@smiklosovic , I reviewed all the `docs` labeled PRs starting from [#206](https://github.com/apache/cassandra/pull/206) and joined them into a single commit here.
The following PRs weren't merged, because they are no longer relevant, either files were removed (completely, I tracked files that were renamed like `*.rst` -> `*.adoc`) or the fixes they proposed were already applied in different commits.
PRs that require attention:
https://github.com/apache/cassandra/pull/1655 - `gen-nodetool-docs.py` script is proposed to get changed in that PR
https://github.com/apache/cassandra/pull/589 - `cqlsh.py` script is proposed to get changed in that PR
PRs that can be safely closed without merging, because I merged them into this PR's commit:
https://github.com/apache/cassandra/pull/206
https://github.com/apache/cassandra/pull/359
https://github.com/apache/cassandra/pull/366
https://github.com/apache/cassandra/pull/390
https://github.com/apache/cassandra/pull/450
https://github.com/apache/cassandra/pull/567
https://github.com/apache/cassandra/pull/615
https://github.com/apache/cassandra/pull/618
https://github.com/apache/cassandra/pull/746
https://github.com/apache/cassandra/pull/974
https://github.com/apache/cassandra/pull/984
https://github.com/apache/cassandra/pull/1052
https://github.com/apache/cassandra/pull/1088
https://github.com/apache/cassandra/pull/1274
https://github.com/apache/cassandra/pull/1378
https://github.com/apache/cassandra/pull/1404
https://github.com/apache/cassandra/pull/1504
https://github.com/apache/cassandra/pull/1540
https://github.com/apache/cassandra/pull/1544
https://github.com/apache/cassandra/pull/1673
https://github.com/apache/cassandra/pull/1697
https://github.com/apache/cassandra/pull/1722
https://github.com/apache/cassandra/pull/1815
https://github.com/apache/cassandra/pull/1830
https://github.com/apache/cassandra/pull/1863
https://github.com/apache/cassandra/pull/1865
https://github.com/apache/cassandra/pull/1879
https://github.com/apache/cassandra/pull/2062
PRs that wasn't merged into this PR's commit, but still can be closed without merging:
https://github.com/apache/cassandra/pull/456 - a complex PR about data modeling, I wasn't sure I could merge it appropriately
https://github.com/apache/cassandra/pull/648 - already fixed in a different commit
https://github.com/apache/cassandra/pull/703 - already fixed in a different commit
https://github.com/apache/cassandra/pull/842 - the file has been removed
https://github.com/apache/cassandra/pull/888 - the file has been removed
https://github.com/apache/cassandra/pull/944 - already fixed in a different commit
https://github.com/apache/cassandra/pull/1073 - already fixed in a different commit
https://github.com/apache/cassandra/pull/1088 - the file has been removed
https://github.com/apache/cassandra/pull/1600 - already fixed in a different commit
https://github.com/apache/cassandra/pull/1808 - already fixed in a different commit
https://github.com/apache/cassandra/pull/1809 - already fixed in a different commit
https://github.com/apache/cassandra/pull/1810 - already fixed in a different commit
https://github.com/apache/cassandra/pull/1829 - already fixed in a different commit
https://github.com/apache/cassandra/pull/1861 - already fixed in a different commit
https://github.com/apache/cassandra/pull/1862 - already fixed in a different commit
https://github.com/apache/cassandra/pull/1864 - already fixed in a different commit
https://github.com/apache/cassandra/pull/1880 - already fixed in a different commit
https://github.com/apache/cassandra/pull/1943 - already fixed in a different commit
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] neshkeev commented on a diff in pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "neshkeev (via GitHub)" <gi...@apache.org>.
neshkeev commented on code in PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#discussion_r1083790765
##########
conf/cqlshrc.sample:
##########
@@ -33,6 +32,10 @@
; classname = PlainTextAuthProvider
; username = user1
+[protocol]
+;; Specify a specific protcol version otherwise the client will default and downgrade as necessary
Review Comment:
@smiklosovic , [here](https://github.com/apache/cassandra/pull/366/files#diff-f55a268d347d301121adb03b1d33958837ed984295b83fbe474dde2781fe809fR26) it is
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1399998312
@neshkeev I believe PR 1073 is still relevant if you closer.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on a diff in pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on code in PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#discussion_r1083766615
##########
conf/cqlshrc.sample:
##########
@@ -33,6 +32,10 @@
; classname = PlainTextAuthProvider
; username = user1
+[protocol]
+;; Specify a specific protcol version otherwise the client will default and downgrade as necessary
Review Comment:
@neshkeev is this really relevant? can you point me to the PR suggesting to add this?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] michaelsembwever commented on a diff in pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "michaelsembwever (via GitHub)" <gi...@apache.org>.
michaelsembwever commented on code in PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#discussion_r1087649059
##########
doc/modules/cassandra/pages/operating/auditlogging.adoc:
##########
@@ -186,52 +210,101 @@ excluded_categories: DDL, DML, QUERY, PREPARE
Users to audit log are set with the `included_users` and `excluded_users` options.
The `included_users` option specifies a comma-separated list of users to include explicitly.
The `excluded_users` option specifies a comma-separated list of users to exclude explicitly.
-By default all users are included, and no users are excluded.
+By default, all users are included, and no users are excluded.
[source, yaml]
----
included_users:
excluded_users: john, mary
----
+[[roll_cycle]]
=== roll_cycle
The ``roll_cycle`` defines the frequency with which the audit log segments are rolled.
-Supported values are ``HOURLY`` (default), ``MINUTELY``, and ``DAILY``.
+Supported values are:
+
+- ``MINUTELY``
+- ``FIVE_MINUTELY``
+- ``TEN_MINUTELY``
+- ``TWENTY_MINUTELY``
+- ``HALF_HOURLY``
+- ``HOURLY`` (default)
+- ``TWO_HOURLY``
+- ``FOUR_HOURLY``
+- ``SIX_HOURLY``
+- ``DAILY``
+
For example: ``roll_cycle: DAILY``
+WARNING: Read the following paragraph when changing ``roll_cycle`` on a production node.
+
+With the `BinLogger` implementation, any attempt to modify the roll cycle on a node where audit logging was previously enabled will fail silentely due to https://github.com/OpenHFT/Chronicle-Queue[Chronicle Queue] roll cycle inference mechanism (even if you delete the ``metadata.cq4t`` file).
+
+Here is an example of such an override visible in Cassandra logs:
+----
+INFO [main] <DATE TIME> BinLog.java:420 - Attempting to configure bin log: Path: /path/to/audit Roll cycle: TWO_HOURLY [...]
+WARN [main] <DATE TIME> SingleChronicleQueueBuilder.java:477 - Overriding roll cycle from TWO_HOURLY to FIVE_MINUTE
+----
+
+In order to change ``roll_cycle`` on a node, you have to:
+
+1. Stop Cassandra
+2. Move or offload all audit logs somewhere else (in a safe and durable location)
+3. Restart Cassandra.
+4. Check Cassandra logs
+5. Make sure that audit log filenames under ``audit_logs_dir`` correspond to the new roll cycle.
+
=== block
The ``block`` option specifies whether audit logging should block writing or drop log records if the audit logging falls behind. Supported boolean values are ``true`` (default) or ``false``.
-For example: ``block: false`` to drop records
+
+For example: ``block: false`` to drop records (e.g. if audit is used for troobleshooting)
+
+For regulatory compliance purpose, it's a good practice to explicitely set ``block: true`` to prevent any regression in case of future default value change.
=== max_queue_weight
The ``max_queue_weight`` option sets the maximum weight of in-memory queue for records waiting to be written to the file before blocking or dropping. The option must be set to a positive value. The default value is 268435456, or 256 MiB.
+
For example, to change the default: ``max_queue_weight: 134217728 # 128 MiB``
=== max_log_size
The ``max_log_size`` option sets the maximum size of the rolled files to retain on disk before deleting the oldest file. The option must be set to a positive value. The default is 17179869184, or 16 GiB.
For example, to change the default: ``max_log_size: 34359738368 # 32 GiB``
+WARNING: ``max_log_size`` is ignored if ``archive_command`` option is set.
+
+[[archive_command]]
=== archive_command
+NOTE: If ``archive_command`` option is empty or unset (default), Cassandra uses a built-in DeletingArchiver that deletes the oldest files if ``max_log_size`` is reached.
+
The ``archive_command`` option sets the user-defined archive script to execute on rolled log files.
-For example: ``archive_command: /usr/local/bin/archiveit.sh %path # %path is the file being rolled``
+For example: ``archive_command: "/usr/local/bin/archiveit.sh %path"``
-=== max_archive_retries
+``%path`` is replaced with the absolute file path of the file being rolled.
-The ``max_archive_retries`` option sets the max number of retries of failed archive commands. The default is 10.
-For example: ``max_archive_retries: 10``
+When using a user-defined script, Cassandra do **not** use the DeletingArchiver, so it's the responsability of the script to make any required cleanup.
+Cassandra will call the user-defined script as soon as the log file is rolled. It means that Chronicle Queue's QueueFileShrinkManager will not be able to shrink the sparse log file because it's done asynchronously. In other words, all log files will have at least the size of the default block size (80 MiB), even if there are only a few KB of real data. Consequently, some warnings will appear in Cassandra system.log:
-An audit log file could get rolled for other reasons as well such as a
-log file reaches the configured size threshold.
+----
+WARN [main/queue~file~shrink~daemon] <DATE TIME> QueueFileShrinkManager.java:63 - Failed to shrink file as it exists no longer, file=/path/to/xxx.cq4
+----
-Audit logging can also be configured using ``nodetool` when enabling the feature, and will override any values set in the `cassandra.yaml` file, as discussed in the next section.
+TIP: Because Cassandra does not make use of Pretoucher, you can configure Chronicle Queue to shrink files synchronously -- i.e. as soon as the file is rolled -- with ``chronicle.queue.synchronousFileShrinking`` JVM properties. For instance, you can add the following line at the end of ``cassandra-env.sh``: ``JVM_OPTS="$JVM_OPTS -Dchronicle.queue.synchronousFileShrinking=true"``
Review Comment:
Does it render correctly when generated? (that really is all we care about – i suspect thinking IDEA rendering helps traps us)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] neshkeev commented on pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "neshkeev (via GitHub)" <gi...@apache.org>.
neshkeev commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1405220274
@smiklosovic , did you decide to do it differently?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] neshkeev commented on a diff in pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "neshkeev (via GitHub)" <gi...@apache.org>.
neshkeev commented on code in PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#discussion_r1083804728
##########
doc/modules/cassandra/pages/tools/cqlsh.adoc:
##########
@@ -38,7 +38,7 @@ modules that are central to the performance of `COPY`.
== cqlshrc
The `cqlshrc` file holds configuration options for `cqlsh`.
-By default, the file is locagted the user's home directory at `~/.cassandra/cqlsh`, but a
+By default, the file is locagted the user's home directory at `~/.cassandra/cqlshrc`, but a
Review Comment:
Good catch! I fixed it
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] neshkeev commented on a diff in pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "neshkeev (via GitHub)" <gi...@apache.org>.
neshkeev commented on code in PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#discussion_r1083806605
##########
conf/cqlshrc.sample:
##########
@@ -109,6 +112,9 @@ port = 9042
;[ssl]
+;; Version of TLS to be used. Required to be set for cassandra version > 3.11.8
Review Comment:
I removed it
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1400141145
@neshkeev You wrote:
_I reviewed all the docs labeled PRs starting from https://github.com/apache/cassandra/pull/206 and joined them into a single commit here._
So, it means that all PRs older than PR 206 (PRs 206 -> 0) are _not reviewed yet_ ? If that is the case, could we review them all?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on a diff in pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on code in PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#discussion_r1083808415
##########
conf/cqlshrc.sample:
##########
@@ -109,6 +112,9 @@ port = 9042
;[ssl]
+;; Version of TLS to be used. Required to be set for cassandra version > 3.11.8
Review Comment:
https://issues.apache.org/jira/browse/CASSANDRA-17452
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on a diff in pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on code in PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#discussion_r1083771246
##########
doc/modules/cassandra/pages/tools/cqlsh.adoc:
##########
@@ -38,7 +38,7 @@ modules that are central to the performance of `COPY`.
== cqlshrc
The `cqlshrc` file holds configuration options for `cqlsh`.
-By default, the file is locagted the user's home directory at `~/.cassandra/cqlsh`, but a
+By default, the file is locagted the user's home directory at `~/.cassandra/cqlshrc`, but a
Review Comment:
`locagted` -> `located`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] neshkeev commented on pull request #2062: Fix typo "the-the" -> "the"
Posted by GitBox <gi...@apache.org>.
neshkeev commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1385009530
I'll peruse the PRs with such a tag and try to combine them into a single one if possible.
Should I somehow include original authors of the PRs I'll combine into a single PR?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1400086563
I believe that #589 and #1655 can be worked on independently from this one. Especially if these patches are planning to be merged in various branches and this targets just trunk.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] neshkeev commented on pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "neshkeev (via GitHub)" <gi...@apache.org>.
neshkeev commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1400138769
> what about cracking thought the rest after (or before) PR 206 as you mentioned?
Sorry, I didn't get that, could you, please rephrase it?
All the changes https://github.com/apache/cassandra/pull/206 proposes are included into this PR, or were fixed before me in different commits, only the [`impact` -> `impacts`](https://github.com/apache/cassandra/pull/206/files#diff-6a259516d12c778b2b08ec408b884a88bf94d14a9f6dd8d943c6e4376288da6dR346) typo is left till now
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1399598762
great work @neshkeev , I will take a closer look shortly.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1416832561
Hi @neshkeev , it was closed because we have committed the work into https://github.com/apache/cassandra/commit/f27790c96912ac9a83f052d8e6d0bfcdfe60ca0e
Once the work has been done, we tend to close the accompanying PR as it just cease to have the reason of its existence.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on pull request #2062: Fix typo "the-the" -> "the"
Posted by GitBox <gi...@apache.org>.
smiklosovic commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1385130587
Preferably.
You do that by specifying `Co-authored-by: ...` in the commit message.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on a diff in pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on code in PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#discussion_r1083765678
##########
conf/cqlshrc.sample:
##########
@@ -109,6 +112,9 @@ port = 9042
;[ssl]
+;; Version of TLS to be used. Required to be set for cassandra version > 3.11.8
Review Comment:
@neshkeev I do not think this is necessary to add, there is this later in `ssl` section:
````
; this is effectively ignored from 4.1 included as TLS protocol is auto-negotiated and will
; be removed in the next major version of Cassandra, possible values were TLSv1, TLSv1_1 or TLSv1_2
;version =
````
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] neshkeev commented on a diff in pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "neshkeev (via GitHub)" <gi...@apache.org>.
neshkeev commented on code in PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#discussion_r1083805108
##########
doc/modules/cassandra/pages/faq/index.adoc:
##########
@@ -79,7 +79,10 @@ intensive process that may result in adverse cluster performance. It's
highly recommended to do rolling repairs, as an attempt to repair the
entire cluster at once will most likely swamp it. Note that you will
need to run a full repair (`-full`) to make sure that already repaired
-sstables are not skipped.
+sstables are not skipped. You should use ConsistencyLevel.QUORUM or ALL
Review Comment:
It's fixed
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1400168976
right ... so I think this is the last one as I put that comment there:
https://github.com/apache/cassandra/pull/180#issuecomment-1400104542
Thanks!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on pull request #2062: Fix typo "the-the" -> "the"
Posted by GitBox <gi...@apache.org>.
smiklosovic commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1385175989
@neshkeev if you go through other PRs related to docs, ping me if you think it is not relevant anymore I will double check and we can close it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on pull request #2062: Fix typo "the-the" -> "the"
Posted by GitBox <gi...@apache.org>.
smiklosovic commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1385002289
Hi @neshkeev
thanks for the patch. I think it will be better if we put all doc-related changes together in one big patch and merge that one. It is not too much "effective" to merge this very tiny change. It would be way more preferable (from my point of view) to create a patch which would gather all docs fixes among pull requests and merge that one and we are ok for good.
I think there is a lot of docs PRs (if you filter them by "docs" tag), some of them might be obsolete and somebody would need to go through them.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] neshkeev commented on a diff in pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "neshkeev (via GitHub)" <gi...@apache.org>.
neshkeev commented on code in PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#discussion_r1083804409
##########
src/java/org/apache/cassandra/service/StartupChecks.java:
##########
@@ -226,7 +226,7 @@ public void execute(StartupChecksOptions options)
public static final StartupCheck checkValidLaunchDate = new StartupCheck()
{
/**
- * The earliest legit timestamp a casandra instance could have ever launched.
+ * The earliest legit timestamp a cassandra instance could have ever launched.
Review Comment:
Fixed
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1400107541
@neshkeev great progress so far! what about cracking thought the rest after (or before) PR 206 as you mentioned?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on a diff in pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on code in PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#discussion_r1083769908
##########
doc/modules/cassandra/pages/faq/index.adoc:
##########
@@ -79,7 +79,10 @@ intensive process that may result in adverse cluster performance. It's
highly recommended to do rolling repairs, as an attempt to repair the
entire cluster at once will most likely swamp it. Note that you will
need to run a full repair (`-full`) to make sure that already repaired
-sstables are not skipped.
+sstables are not skipped. You should use ConsistencyLevel.QUORUM or ALL
Review Comment:
may be ... `ConsistencyLevel.QUORUM` or `ALL` ...
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic closed pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic closed pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
URL: https://github.com/apache/cassandra/pull/2062
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic closed pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic closed pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
URL: https://github.com/apache/cassandra/pull/2062
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] polandll commented on a diff in pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "polandll (via GitHub)" <gi...@apache.org>.
polandll commented on code in PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#discussion_r1087130975
##########
doc/modules/cassandra/pages/architecture/dynamo.adoc:
##########
@@ -256,7 +255,7 @@ secondary indices with them.
Transient replication is an experimental feature that is not ready
for production use. The expected audience is experienced users of
Cassandra capable of fully validating a deployment of their particular
-application. That means being able check that operations like reads,
+application. That means being able to check that operations like reads,
Review Comment:
```suggestion
application. That means you have the experience to check that operations like reads,
```
##########
doc/modules/cassandra/pages/architecture/guarantees.adoc:
##########
@@ -97,12 +97,12 @@ uncommitted, without making a new addition or update.
The guarantee for batched writes across multiple tables is that they
will eventually succeed, or none will. Batch data is first written to
batchlog system data, and when the batch data has been successfully
-stored in the cluster the batchlog data is removed. The batch is
-replicated to another node to ensure the full batch completes in the
-event the coordinator node fails.
+stored in the cluster, the batchlog data is removed. The batch is
+replicated to another node to ensure that the full batch completes in
+the event if the coordinator node fails.
Review Comment:
```suggestion
the event the coordinator node fails.
```
##########
doc/modules/cassandra/pages/architecture/snitch.adoc:
##########
@@ -2,17 +2,17 @@
In cassandra, the snitch has two functions:
-* it teaches Cassandra enough about your network topology to route
+* It teaches Cassandra enough about your network topology to route
requests efficiently.
-* it allows Cassandra to spread replicas around your cluster to avoid
+* It allows Cassandra to spread replicas around your cluster to avoid
Review Comment:
same comment
##########
doc/modules/cassandra/pages/cql/types.adoc:
##########
@@ -338,13 +338,13 @@ include::example$CQL/update_list.cql[]
.Warning
====
The append and prepend operations are not idempotent by nature. So in
-particular, if one of these operation timeout, then retrying the
+particular, if one of these operations timeout, then retrying the
Review Comment:
```suggestion
particular, if one of these operations times out, then retrying the
```
##########
doc/modules/cassandra/pages/architecture/overview.adoc:
##########
@@ -59,19 +59,19 @@ keys.
CQL supports numerous advanced features over a partitioned dataset such
as:
-* Single partition lightweight transactions with atomic compare and set
-semantics.
+* Single-partition lightweight transactions with atomic compare and set
+semantics
* User-defined types, functions and aggregates
-* Collection types including sets, maps, and lists.
+* Collection types including sets, maps, and lists
* Local secondary indices
-* (Experimental) materialized views
+* (Experimental) materialized views.
Review Comment:
```suggestion
* (Experimental) materialized views
```
##########
doc/modules/cassandra/pages/operating/auditlogging.adoc:
##########
@@ -186,52 +210,101 @@ excluded_categories: DDL, DML, QUERY, PREPARE
Users to audit log are set with the `included_users` and `excluded_users` options.
The `included_users` option specifies a comma-separated list of users to include explicitly.
The `excluded_users` option specifies a comma-separated list of users to exclude explicitly.
-By default all users are included, and no users are excluded.
+By default, all users are included, and no users are excluded.
[source, yaml]
----
included_users:
excluded_users: john, mary
----
+[[roll_cycle]]
=== roll_cycle
The ``roll_cycle`` defines the frequency with which the audit log segments are rolled.
-Supported values are ``HOURLY`` (default), ``MINUTELY``, and ``DAILY``.
+Supported values are:
+
+- ``MINUTELY``
+- ``FIVE_MINUTELY``
+- ``TEN_MINUTELY``
+- ``TWENTY_MINUTELY``
+- ``HALF_HOURLY``
+- ``HOURLY`` (default)
+- ``TWO_HOURLY``
+- ``FOUR_HOURLY``
+- ``SIX_HOURLY``
+- ``DAILY``
+
For example: ``roll_cycle: DAILY``
+WARNING: Read the following paragraph when changing ``roll_cycle`` on a production node.
+
+With the `BinLogger` implementation, any attempt to modify the roll cycle on a node where audit logging was previously enabled will fail silentely due to https://github.com/OpenHFT/Chronicle-Queue[Chronicle Queue] roll cycle inference mechanism (even if you delete the ``metadata.cq4t`` file).
+
+Here is an example of such an override visible in Cassandra logs:
+----
+INFO [main] <DATE TIME> BinLog.java:420 - Attempting to configure bin log: Path: /path/to/audit Roll cycle: TWO_HOURLY [...]
+WARN [main] <DATE TIME> SingleChronicleQueueBuilder.java:477 - Overriding roll cycle from TWO_HOURLY to FIVE_MINUTE
+----
+
+In order to change ``roll_cycle`` on a node, you have to:
+
+1. Stop Cassandra
+2. Move or offload all audit logs somewhere else (in a safe and durable location)
+3. Restart Cassandra.
+4. Check Cassandra logs
+5. Make sure that audit log filenames under ``audit_logs_dir`` correspond to the new roll cycle.
+
=== block
The ``block`` option specifies whether audit logging should block writing or drop log records if the audit logging falls behind. Supported boolean values are ``true`` (default) or ``false``.
-For example: ``block: false`` to drop records
+
+For example: ``block: false`` to drop records (e.g. if audit is used for troobleshooting)
+
+For regulatory compliance purpose, it's a good practice to explicitely set ``block: true`` to prevent any regression in case of future default value change.
=== max_queue_weight
The ``max_queue_weight`` option sets the maximum weight of in-memory queue for records waiting to be written to the file before blocking or dropping. The option must be set to a positive value. The default value is 268435456, or 256 MiB.
+
For example, to change the default: ``max_queue_weight: 134217728 # 128 MiB``
=== max_log_size
The ``max_log_size`` option sets the maximum size of the rolled files to retain on disk before deleting the oldest file. The option must be set to a positive value. The default is 17179869184, or 16 GiB.
For example, to change the default: ``max_log_size: 34359738368 # 32 GiB``
+WARNING: ``max_log_size`` is ignored if ``archive_command`` option is set.
+
+[[archive_command]]
=== archive_command
+NOTE: If ``archive_command`` option is empty or unset (default), Cassandra uses a built-in DeletingArchiver that deletes the oldest files if ``max_log_size`` is reached.
+
The ``archive_command`` option sets the user-defined archive script to execute on rolled log files.
-For example: ``archive_command: /usr/local/bin/archiveit.sh %path # %path is the file being rolled``
+For example: ``archive_command: "/usr/local/bin/archiveit.sh %path"``
-=== max_archive_retries
+``%path`` is replaced with the absolute file path of the file being rolled.
-The ``max_archive_retries`` option sets the max number of retries of failed archive commands. The default is 10.
-For example: ``max_archive_retries: 10``
+When using a user-defined script, Cassandra do **not** use the DeletingArchiver, so it's the responsability of the script to make any required cleanup.
Review Comment:
```suggestion
When using a user-defined script, Cassandra does **not** use the DeletingArchiver, so it's the responsibility of the script to make any required cleanup.
```
##########
doc/modules/cassandra/pages/operating/auditlogging.adoc:
##########
@@ -186,52 +210,101 @@ excluded_categories: DDL, DML, QUERY, PREPARE
Users to audit log are set with the `included_users` and `excluded_users` options.
The `included_users` option specifies a comma-separated list of users to include explicitly.
The `excluded_users` option specifies a comma-separated list of users to exclude explicitly.
-By default all users are included, and no users are excluded.
+By default, all users are included, and no users are excluded.
[source, yaml]
----
included_users:
excluded_users: john, mary
----
+[[roll_cycle]]
=== roll_cycle
The ``roll_cycle`` defines the frequency with which the audit log segments are rolled.
-Supported values are ``HOURLY`` (default), ``MINUTELY``, and ``DAILY``.
+Supported values are:
+
+- ``MINUTELY``
+- ``FIVE_MINUTELY``
+- ``TEN_MINUTELY``
+- ``TWENTY_MINUTELY``
+- ``HALF_HOURLY``
+- ``HOURLY`` (default)
+- ``TWO_HOURLY``
+- ``FOUR_HOURLY``
+- ``SIX_HOURLY``
+- ``DAILY``
+
For example: ``roll_cycle: DAILY``
+WARNING: Read the following paragraph when changing ``roll_cycle`` on a production node.
+
+With the `BinLogger` implementation, any attempt to modify the roll cycle on a node where audit logging was previously enabled will fail silentely due to https://github.com/OpenHFT/Chronicle-Queue[Chronicle Queue] roll cycle inference mechanism (even if you delete the ``metadata.cq4t`` file).
+
+Here is an example of such an override visible in Cassandra logs:
+----
+INFO [main] <DATE TIME> BinLog.java:420 - Attempting to configure bin log: Path: /path/to/audit Roll cycle: TWO_HOURLY [...]
+WARN [main] <DATE TIME> SingleChronicleQueueBuilder.java:477 - Overriding roll cycle from TWO_HOURLY to FIVE_MINUTE
+----
+
+In order to change ``roll_cycle`` on a node, you have to:
+
+1. Stop Cassandra
+2. Move or offload all audit logs somewhere else (in a safe and durable location)
+3. Restart Cassandra.
+4. Check Cassandra logs
+5. Make sure that audit log filenames under ``audit_logs_dir`` correspond to the new roll cycle.
+
=== block
The ``block`` option specifies whether audit logging should block writing or drop log records if the audit logging falls behind. Supported boolean values are ``true`` (default) or ``false``.
-For example: ``block: false`` to drop records
+
+For example: ``block: false`` to drop records (e.g. if audit is used for troobleshooting)
+
+For regulatory compliance purpose, it's a good practice to explicitely set ``block: true`` to prevent any regression in case of future default value change.
=== max_queue_weight
The ``max_queue_weight`` option sets the maximum weight of in-memory queue for records waiting to be written to the file before blocking or dropping. The option must be set to a positive value. The default value is 268435456, or 256 MiB.
+
For example, to change the default: ``max_queue_weight: 134217728 # 128 MiB``
=== max_log_size
The ``max_log_size`` option sets the maximum size of the rolled files to retain on disk before deleting the oldest file. The option must be set to a positive value. The default is 17179869184, or 16 GiB.
For example, to change the default: ``max_log_size: 34359738368 # 32 GiB``
+WARNING: ``max_log_size`` is ignored if ``archive_command`` option is set.
+
+[[archive_command]]
=== archive_command
+NOTE: If ``archive_command`` option is empty or unset (default), Cassandra uses a built-in DeletingArchiver that deletes the oldest files if ``max_log_size`` is reached.
+
The ``archive_command`` option sets the user-defined archive script to execute on rolled log files.
-For example: ``archive_command: /usr/local/bin/archiveit.sh %path # %path is the file being rolled``
+For example: ``archive_command: "/usr/local/bin/archiveit.sh %path"``
-=== max_archive_retries
+``%path`` is replaced with the absolute file path of the file being rolled.
-The ``max_archive_retries`` option sets the max number of retries of failed archive commands. The default is 10.
-For example: ``max_archive_retries: 10``
+When using a user-defined script, Cassandra do **not** use the DeletingArchiver, so it's the responsability of the script to make any required cleanup.
+Cassandra will call the user-defined script as soon as the log file is rolled. It means that Chronicle Queue's QueueFileShrinkManager will not be able to shrink the sparse log file because it's done asynchronously. In other words, all log files will have at least the size of the default block size (80 MiB), even if there are only a few KB of real data. Consequently, some warnings will appear in Cassandra system.log:
-An audit log file could get rolled for other reasons as well such as a
-log file reaches the configured size threshold.
+----
+WARN [main/queue~file~shrink~daemon] <DATE TIME> QueueFileShrinkManager.java:63 - Failed to shrink file as it exists no longer, file=/path/to/xxx.cq4
+----
-Audit logging can also be configured using ``nodetool` when enabling the feature, and will override any values set in the `cassandra.yaml` file, as discussed in the next section.
+TIP: Because Cassandra does not make use of Pretoucher, you can configure Chronicle Queue to shrink files synchronously -- i.e. as soon as the file is rolled -- with ``chronicle.queue.synchronousFileShrinking`` JVM properties. For instance, you can add the following line at the end of ``cassandra-env.sh``: ``JVM_OPTS="$JVM_OPTS -Dchronicle.queue.synchronousFileShrinking=true"``
Review Comment:
```suggestion
TIP:
====
Because Cassandra does not make use of Pretoucher, you can configure Chronicle Queue to shrink files synchronously -- i.e. as soon as the file is rolled -- with `chronicle.queue.synchronousFileShrinking` JVM properties. For instance, you can add the following line at the end of `cassandra-env.sh`: `JVM_OPTS="$JVM_OPTS -Dchronicle.queue.synchronousFileShrinking=true"`
====
##########
doc/modules/cassandra/pages/architecture/storage_engine.adoc:
##########
@@ -221,5 +224,5 @@ match the "ib" SSTable version
[source,bash]
----
-include:example$find_sstables.sh[]
+include::../../examples/BASH/find_sstables.sh[]
Review Comment:
Never use a path in includes in asciidoc/antora. https://docs.antora.org/antora/latest/page/include-an-example/
##########
doc/modules/cassandra/pages/architecture/storage_engine.adoc:
##########
@@ -221,5 +224,5 @@ match the "ib" SSTable version
[source,bash]
----
-include:example$find_sstables.sh[]
+include::../../examples/BASH/find_sstables.sh[]
Review Comment:
```suggestion
include::example$BASH/find_sstables.sh[]
```
##########
doc/modules/cassandra/pages/operating/auditlogging.adoc:
##########
@@ -123,16 +136,25 @@ audit_logging_options:
=== enabled
-Audit logging is enabled by setting the `enabled` option to `true` in
-the `audit_logging_options` setting.
+Control wether audit logging is enabled or disabled (default).
Review Comment:
```suggestion
Control whether audit logging is enabled or disabled (default).
```
##########
doc/modules/cassandra/pages/operating/auditlogging.adoc:
##########
@@ -88,10 +88,23 @@ Common audit log entry types are one of the following:
| ERROR | REQUEST_FAILURE
|===
+== Availability and durability
+
+NOTE: Unlike data, audit log entries are not replicated
+
+For a given query, the corresponding audit entry is only stored on the coordinator node.
+For example, an ``INSERT`` in a keyspace with replication factor of 3 will produce an audit entry on one node, the coordinator who handled the request, and not on the two other nodes.
+For this reason, and depending on compliance requirements you must meet, you have to make sure that audig logs are stored on a non-ephemeral storage.
Review Comment:
```suggestion
For this reason, and depending on compliance requirements you must meet, make sure that audit logs are stored on a non-ephemeral storage.
```
##########
doc/modules/cassandra/pages/architecture/snitch.adoc:
##########
@@ -2,17 +2,17 @@
In cassandra, the snitch has two functions:
-* it teaches Cassandra enough about your network topology to route
+* It teaches Cassandra enough about your network topology to route
Review Comment:
Generally, with a colon in the previous sentence, you use lowercase to start the bullet item.
##########
doc/modules/cassandra/pages/architecture/storage_engine.adoc:
##########
@@ -3,17 +3,17 @@
[[commit-log]]
== CommitLog
-Commitlogs are an append only log of all mutations local to a Cassandra
+Commitlogs are an append-only log of all mutations local to a Cassandra
node. Any data written to Cassandra will first be written to a commit
log before being written to a memtable. This provides durability in the
case of unexpected shutdown. On startup, any mutations in the commit log
will be applied to memtables.
-All mutations write optimized by storing in commitlog segments, reducing
-the number of seeks needed to write to disk. Commitlog Segments are
-limited by the `commitlog_segment_size` option, once the size is
+All mutations are write-optimized by storing in commitlog segments, reducing
+the number of seeks needed to write to disk. Commitlog segments are
+limited by the `commitlog_segment_size` option. Once the size is
reached, a new commitlog segment is created. Commitlog segments can be
-archived, deleted, or recycled once all its data has been flushed to
+archived, deleted, or recycled once all their data has been flushed to
Review Comment:
```suggestion
archived, deleted, or recycled once all the data has been flushed to
```
##########
doc/modules/cassandra/pages/operating/auditlogging.adoc:
##########
@@ -186,52 +210,101 @@ excluded_categories: DDL, DML, QUERY, PREPARE
Users to audit log are set with the `included_users` and `excluded_users` options.
The `included_users` option specifies a comma-separated list of users to include explicitly.
The `excluded_users` option specifies a comma-separated list of users to exclude explicitly.
-By default all users are included, and no users are excluded.
+By default, all users are included, and no users are excluded.
[source, yaml]
----
included_users:
excluded_users: john, mary
----
+[[roll_cycle]]
=== roll_cycle
The ``roll_cycle`` defines the frequency with which the audit log segments are rolled.
-Supported values are ``HOURLY`` (default), ``MINUTELY``, and ``DAILY``.
+Supported values are:
+
+- ``MINUTELY``
+- ``FIVE_MINUTELY``
+- ``TEN_MINUTELY``
+- ``TWENTY_MINUTELY``
+- ``HALF_HOURLY``
+- ``HOURLY`` (default)
+- ``TWO_HOURLY``
+- ``FOUR_HOURLY``
+- ``SIX_HOURLY``
+- ``DAILY``
+
For example: ``roll_cycle: DAILY``
+WARNING: Read the following paragraph when changing ``roll_cycle`` on a production node.
+
+With the `BinLogger` implementation, any attempt to modify the roll cycle on a node where audit logging was previously enabled will fail silentely due to https://github.com/OpenHFT/Chronicle-Queue[Chronicle Queue] roll cycle inference mechanism (even if you delete the ``metadata.cq4t`` file).
+
+Here is an example of such an override visible in Cassandra logs:
+----
+INFO [main] <DATE TIME> BinLog.java:420 - Attempting to configure bin log: Path: /path/to/audit Roll cycle: TWO_HOURLY [...]
+WARN [main] <DATE TIME> SingleChronicleQueueBuilder.java:477 - Overriding roll cycle from TWO_HOURLY to FIVE_MINUTE
+----
+
+In order to change ``roll_cycle`` on a node, you have to:
+
+1. Stop Cassandra
+2. Move or offload all audit logs somewhere else (in a safe and durable location)
+3. Restart Cassandra.
+4. Check Cassandra logs
+5. Make sure that audit log filenames under ``audit_logs_dir`` correspond to the new roll cycle.
+
=== block
The ``block`` option specifies whether audit logging should block writing or drop log records if the audit logging falls behind. Supported boolean values are ``true`` (default) or ``false``.
-For example: ``block: false`` to drop records
+
+For example: ``block: false`` to drop records (e.g. if audit is used for troobleshooting)
+
+For regulatory compliance purpose, it's a good practice to explicitely set ``block: true`` to prevent any regression in case of future default value change.
Review Comment:
```suggestion
For regulatory compliance purposes, it's a good practice to explicitly set ``block: true`` to prevent any regression in case of future default value change.
```
##########
doc/modules/cassandra/pages/operating/auditlogging.adoc:
##########
@@ -88,10 +88,23 @@ Common audit log entry types are one of the following:
| ERROR | REQUEST_FAILURE
|===
+== Availability and durability
+
+NOTE: Unlike data, audit log entries are not replicated
+
+For a given query, the corresponding audit entry is only stored on the coordinator node.
+For example, an ``INSERT`` in a keyspace with replication factor of 3 will produce an audit entry on one node, the coordinator who handled the request, and not on the two other nodes.
+For this reason, and depending on compliance requirements you must meet, you have to make sure that audig logs are stored on a non-ephemeral storage.
+
+You can achieve custom needs with <<archive_command>> option.
Review Comment:
```suggestion
You can achieve custom needs with the <<archive_command>> option.
```
##########
doc/modules/cassandra/pages/architecture/storage_engine.adoc:
##########
@@ -3,17 +3,17 @@
[[commit-log]]
== CommitLog
-Commitlogs are an append only log of all mutations local to a Cassandra
+Commitlogs are an append-only log of all mutations local to a Cassandra
node. Any data written to Cassandra will first be written to a commit
log before being written to a memtable. This provides durability in the
case of unexpected shutdown. On startup, any mutations in the commit log
will be applied to memtables.
-All mutations write optimized by storing in commitlog segments, reducing
-the number of seeks needed to write to disk. Commitlog Segments are
-limited by the `commitlog_segment_size` option, once the size is
+All mutations are write-optimized by storing in commitlog segments, reducing
+the number of seeks needed to write to disk. Commitlog segments are
+limited by the `commitlog_segment_size` option. Once the size is
reached, a new commitlog segment is created. Commitlog segments can be
-archived, deleted, or recycled once all its data has been flushed to
+archived, deleted, or recycled once all their data has been flushed to
Review Comment:
Don't anthropomorphize. a commit log is not a person. :-)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] neshkeev commented on pull request #2062: Fix typo "the-the" -> "the"
Posted by GitBox <gi...@apache.org>.
neshkeev commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1384322437
@smiklosovic , could you help me find someone who can merge the PR, please?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] neshkeev commented on a diff in pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "neshkeev (via GitHub)" <gi...@apache.org>.
neshkeev commented on code in PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#discussion_r1083805587
##########
doc/modules/cassandra/pages/architecture/guarantees.adoc:
##########
@@ -47,46 +51,50 @@ Cassandra makes the following guarantees.
* Batched writes across multiple tables are guaranteed to succeed
completely or not at all
* Secondary indexes are guaranteed to be consistent with their local
-replicas data
+replicas' data
== High Scalability
Cassandra is a highly scalable storage system in which nodes may be
-added/removed as needed. Using gossip-based protocol a unified and
+added/removed as needed. Using gossip-based protocol, a unified and
consistent membership list is kept at each node.
== High Availability
Cassandra guarantees high availability of data by implementing a
-fault-tolerant storage system. Failure detection in a node is detected
-using a gossip-based protocol.
+fault-tolerant storage system. Failure of a node is detected using
+a gossip-based protocol.
== Durability
Cassandra guarantees data durability by using replicas. Replicas are
multiple copies of a data stored on different nodes in a cluster. In a
multi-datacenter environment the replicas may be stored on different
datacenters. If one replica is lost due to unrecoverable node/datacenter
-failure the data is not completely lost as replicas are still available.
+<<<<<<< HEAD
Review Comment:
It's fixed
##########
doc/modules/cassandra/pages/architecture/guarantees.adoc:
##########
@@ -1,17 +1,21 @@
= Guarantees
Apache Cassandra is a highly scalable and reliable database. Cassandra
-is used in web based applications that serve large number of clients and
+<<<<<<< HEAD
Review Comment:
It's fixed
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] neshkeev commented on pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "neshkeev (via GitHub)" <gi...@apache.org>.
neshkeev commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1400016597
> @neshkeev I believe PR 1073 is still relevant if you closer.
The changes it proposes were proposed in the [#1052](https://github.com/apache/cassandra/pull/1052/files#diff-a63e202ba3c4f0ac0e2667dc30d7bba293011ed9917be8e2244e8f40cf4bb445R386) PR and they are in [the current PR](https://github.com/apache/cassandra/pull/2062/files#diff-7b9caadf725c996c57188d3403035f79bdff83dc12dd510da5faf970d0ec9cd2R455)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1400074833
@neshkeev could you please specifically check this one? https://github.com/apache/cassandra/pull/1052/files#r1083818544
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] neshkeev commented on pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "neshkeev (via GitHub)" <gi...@apache.org>.
neshkeev commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1400154222
I should've emphasize it earlier: 206 is the first (chronologically) PR that is labeled with `docs`, there are no `docs` PRs before 206
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1403907327
I am not completely sure about these typos in java classes, they might probably go in as well but we should ask. It is categorically something different to commit "documentation" and "fix typos in sources".
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] neshkeev commented on pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "neshkeev (via GitHub)" <gi...@apache.org>.
neshkeev commented on PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#issuecomment-1416802888
@smiklosovic , please let me know why the PR got closed. I don't understand why it happened and how one can be helpful to the project.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org
[GitHub] [cassandra] smiklosovic commented on a diff in pull request #2062: CASSANDRA-18185 Accumulate all `docs` PR
Posted by "smiklosovic (via GitHub)" <gi...@apache.org>.
smiklosovic commented on code in PR #2062:
URL: https://github.com/apache/cassandra/pull/2062#discussion_r1087601506
##########
doc/modules/cassandra/pages/operating/auditlogging.adoc:
##########
@@ -186,52 +210,101 @@ excluded_categories: DDL, DML, QUERY, PREPARE
Users to audit log are set with the `included_users` and `excluded_users` options.
The `included_users` option specifies a comma-separated list of users to include explicitly.
The `excluded_users` option specifies a comma-separated list of users to exclude explicitly.
-By default all users are included, and no users are excluded.
+By default, all users are included, and no users are excluded.
[source, yaml]
----
included_users:
excluded_users: john, mary
----
+[[roll_cycle]]
=== roll_cycle
The ``roll_cycle`` defines the frequency with which the audit log segments are rolled.
-Supported values are ``HOURLY`` (default), ``MINUTELY``, and ``DAILY``.
+Supported values are:
+
+- ``MINUTELY``
+- ``FIVE_MINUTELY``
+- ``TEN_MINUTELY``
+- ``TWENTY_MINUTELY``
+- ``HALF_HOURLY``
+- ``HOURLY`` (default)
+- ``TWO_HOURLY``
+- ``FOUR_HOURLY``
+- ``SIX_HOURLY``
+- ``DAILY``
+
For example: ``roll_cycle: DAILY``
+WARNING: Read the following paragraph when changing ``roll_cycle`` on a production node.
+
+With the `BinLogger` implementation, any attempt to modify the roll cycle on a node where audit logging was previously enabled will fail silentely due to https://github.com/OpenHFT/Chronicle-Queue[Chronicle Queue] roll cycle inference mechanism (even if you delete the ``metadata.cq4t`` file).
+
+Here is an example of such an override visible in Cassandra logs:
+----
+INFO [main] <DATE TIME> BinLog.java:420 - Attempting to configure bin log: Path: /path/to/audit Roll cycle: TWO_HOURLY [...]
+WARN [main] <DATE TIME> SingleChronicleQueueBuilder.java:477 - Overriding roll cycle from TWO_HOURLY to FIVE_MINUTE
+----
+
+In order to change ``roll_cycle`` on a node, you have to:
+
+1. Stop Cassandra
+2. Move or offload all audit logs somewhere else (in a safe and durable location)
+3. Restart Cassandra.
+4. Check Cassandra logs
+5. Make sure that audit log filenames under ``audit_logs_dir`` correspond to the new roll cycle.
+
=== block
The ``block`` option specifies whether audit logging should block writing or drop log records if the audit logging falls behind. Supported boolean values are ``true`` (default) or ``false``.
-For example: ``block: false`` to drop records
+
+For example: ``block: false`` to drop records (e.g. if audit is used for troobleshooting)
+
+For regulatory compliance purpose, it's a good practice to explicitely set ``block: true`` to prevent any regression in case of future default value change.
=== max_queue_weight
The ``max_queue_weight`` option sets the maximum weight of in-memory queue for records waiting to be written to the file before blocking or dropping. The option must be set to a positive value. The default value is 268435456, or 256 MiB.
+
For example, to change the default: ``max_queue_weight: 134217728 # 128 MiB``
=== max_log_size
The ``max_log_size`` option sets the maximum size of the rolled files to retain on disk before deleting the oldest file. The option must be set to a positive value. The default is 17179869184, or 16 GiB.
For example, to change the default: ``max_log_size: 34359738368 # 32 GiB``
+WARNING: ``max_log_size`` is ignored if ``archive_command`` option is set.
+
+[[archive_command]]
=== archive_command
+NOTE: If ``archive_command`` option is empty or unset (default), Cassandra uses a built-in DeletingArchiver that deletes the oldest files if ``max_log_size`` is reached.
+
The ``archive_command`` option sets the user-defined archive script to execute on rolled log files.
-For example: ``archive_command: /usr/local/bin/archiveit.sh %path # %path is the file being rolled``
+For example: ``archive_command: "/usr/local/bin/archiveit.sh %path"``
-=== max_archive_retries
+``%path`` is replaced with the absolute file path of the file being rolled.
-The ``max_archive_retries`` option sets the max number of retries of failed archive commands. The default is 10.
-For example: ``max_archive_retries: 10``
+When using a user-defined script, Cassandra do **not** use the DeletingArchiver, so it's the responsability of the script to make any required cleanup.
+Cassandra will call the user-defined script as soon as the log file is rolled. It means that Chronicle Queue's QueueFileShrinkManager will not be able to shrink the sparse log file because it's done asynchronously. In other words, all log files will have at least the size of the default block size (80 MiB), even if there are only a few KB of real data. Consequently, some warnings will appear in Cassandra system.log:
-An audit log file could get rolled for other reasons as well such as a
-log file reaches the configured size threshold.
+----
+WARN [main/queue~file~shrink~daemon] <DATE TIME> QueueFileShrinkManager.java:63 - Failed to shrink file as it exists no longer, file=/path/to/xxx.cq4
+----
-Audit logging can also be configured using ``nodetool` when enabling the feature, and will override any values set in the `cassandra.yaml` file, as discussed in the next section.
+TIP: Because Cassandra does not make use of Pretoucher, you can configure Chronicle Queue to shrink files synchronously -- i.e. as soon as the file is rolled -- with ``chronicle.queue.synchronousFileShrinking`` JVM properties. For instance, you can add the following line at the end of ``cassandra-env.sh``: ``JVM_OPTS="$JVM_OPTS -Dchronicle.queue.synchronousFileShrinking=true"``
Review Comment:
This does not render it correctly in IDEA. I left it unchanged.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: pr-unsubscribe@cassandra.apache.org
For additional commands, e-mail: pr-help@cassandra.apache.org