Skip to content

Commit 6224cf4

Browse files
alina-derkach-oazaalina-derkach-oaza
authored
PS-10076 [DOCS] Fix broken links in doc project (8.4) (#540)
modified: docs/audit-log-filter-overview.md modified: docs/audit-log-filter-variables.md modified: docs/data-masking-function-list.md modified: docs/data-masking-overview.md modified: docs/enforce-engine.md modified: docs/feature-comparison.md modified: docs/index-info-schema-tables.md modified: docs/jemalloc-profiling.md modified: docs/ldap-authentication.md modified: docs/manage-audit-log-filter.md modified: docs/myrocks-data-loading.md modified: docs/myrocks-limitations.md modified: docs/myrocks-server-variables.md modified: docs/post-installation.md modified: docs/procfs-plugin.md modified: docs/quickstart-apt.md modified: docs/quickstart-docker.md modified: docs/quickstart-yum.md modified: docs/utility-user.mdЭ
1 parent 094a520 commit 6224cf4

20 files changed

+63
-162
lines changed

‎docs/audit-log-filter-overview.md

Lines changed: 10 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The Audit Log Filter component allows you to monitor, log, and block a connectio
44

55
Enabling the component produces a log file that contains a record of server activity. The log file has information on connections and databases accessed by that connection.
66

7-
The component uses the `mysql` system database to store filter and user account data. Set the [`audit_log_filter.database`](audit-log-filter-variables.md#audit_log_filter.database) variable at server startup to select a different database.
7+
The component uses the `mysql` system database to store filter and user account data. Set the [`audit_log_filter.database`](audit-log-filter-variables.md#audit_log_filterdatabase) variable at server startup to select a different database.
88

99
The `AUDIT_ADMIN` privilege is required to enable users to manage the Audit Log Filter component.
1010

@@ -26,106 +26,15 @@ The Audit Log Filter component uses `mysql` system database tables in the `InnoD
2626

2727
The `audit_log_filter` table stores the definitions of the filters and has the following column definitions:
2828

29-
<!DOCTYPE html>
30-
<html>
31-
<head>
32-
<title>HTML Table Generator</title>
33-
<style>
34-
#demTable {
35-
width:100%;
36-
height:100%;
37-
border:1px solid #b3adad;
38-
border-collapse:collapse;
39-
padding:5px;
40-
}
41-
#demTable th {
42-
border:1px solid #b3adad;
43-
padding:5px;
44-
background: #f0f0f0;
45-
color: #313030;
46-
}
47-
#demTable td {
48-
border:1px solid #b3adad;
49-
text-align:left;
50-
padding:5px;
51-
background: #ffffff;
52-
color: #313030;
53-
}
54-
</style>
55-
</head>
56-
<body>
57-
<table id="demTable">
58-
<thead>
59-
<tr>
60-
<th><div style="color: #333333;background-color: #f5f5f5;font-family: Menlo, Monaco, 'Courier New', monospace;font-weight: normal;font-size: 14px;line-height: 21px;white-space: pre;">Column name</div></th>
61-
<th><div style="color: #333333;background-color: #f5f5f5;font-family: Menlo, Monaco, 'Courier New', monospace;font-weight: normal;font-size: 14px;line-height: 21px;white-space: pre;">Description</div></th>
62-
</tr>
63-
</thead>
64-
<tbody>
65-
<tr>
66-
<td>&nbsp;NAME</td>
67-
<td>&nbsp;Name of the filter</td>
68-
</tr>
69-
<tr>
70-
<td>&nbsp;FILTER</td>
71-
<td>&nbsp;Definition of the filter linked to the name as a JSON value</td>
72-
</tr>
73-
</tbody>
74-
</table>
75-
</body>
76-
</html>
29+
| Column name | Description |
30+
|-------------|---------------------------------------------------------------|
31+
| NAME | Name of the filter |
32+
| FILTER | Definition of the filter linked to the name as a JSON value |
7733

7834
The `audit_log_user` table stores account data and has the following column definitions:
7935

80-
<!DOCTYPE html>
81-
<html>
82-
<head>
83-
<title>HTML Table Generator</title>
84-
<style>
85-
#demTable {
86-
width:100%;
87-
height:100%;
88-
border:1px solid #b3adad;
89-
border-collapse:collapse;
90-
padding:5px;
91-
}
92-
#demTable th {
93-
border:1px solid #b3adad;
94-
padding:5px;
95-
background: #f0f0f0;
96-
color: #313030;
97-
}
98-
#demTable td {
99-
border:1px solid #b3adad;
100-
text-align:left;
101-
padding:5px;
102-
background: #ffffff;
103-
color: #313030;
104-
}
105-
</style>
106-
</head>
107-
<body>
108-
<table id="demTable">
109-
<thead>
110-
<tr>
111-
<th><div style="color: #333333;background-color: #f5f5f5;font-family: Menlo, Monaco, 'Courier New', monospace;font-weight: normal;font-size: 14px;line-height: 21px;white-space: pre;">Column name</div></th>
112-
<th><div style="color: #333333;background-color: #f5f5f5;font-family: Menlo, Monaco, 'Courier New', monospace;font-weight: normal;font-size: 14px;line-height: 21px;white-space: pre;">Description</div></th>
113-
</tr>
114-
</thead>
115-
<tbody>
116-
<tr>
117-
<td>&nbsp;USER</td>
118-
<td>&nbsp;The account name of the user</td>
119-
</tr>
120-
<tr>
121-
<td>&nbsp;HOST</td>
122-
<td>&nbsp;The account name of the host</td>
123-
</tr>
124-
<tr>
125-
<td>&nbsp;FILTERNAME</td>
126-
<td>&nbsp;The account filter name</td>
127-
</tr>
128-
</tbody>
129-
</table>
130-
</body>
131-
</html>
36+
| Column name | Description |
37+
|--------------|-------------------------------------|
38+
| USER | The account name of the user |
39+
| HOST | The account name of the host |
40+
| FILTERNAME | The account filter name |

‎docs/audit-log-filter-variables.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,6 @@ mysql> SELECT audit_log_filter_set_user('user-name@localhost', 'filter-name');
341341

342342
| Name |
343343
| --- |
344-
| [`audit-log-filter`](#audit-logvalue) |
345344
| [`audit_log_filter.buffer_size`](#audit_log_filterbuffer_size) |
346345
| [`audit_log_filter.compression`](#audit_log_filtercompression) |
347346
| [`audit_log_filter.database`](#audit_log_filterdatabase) |
@@ -555,7 +554,7 @@ Pruning requires the following options:
555554

556555
* [`audit_log_filter.max_size`](#audit_log_filtermax_size)
557556

558-
* [`audit_log_filter.prune_seconds`](#audit_log_filterpruneseconds)
557+
* [`audit_log_filter.prune_seconds`](#audit_log_filterprune_seconds)
559558

560559

561560
### `audit_log_filter.password_history_keep_days`
@@ -576,7 +575,7 @@ The default value is 0 (zero). This value disables the expiration of passwords.
576575

577576
If the component starts and encryption is enabled, the component checks for an audit log filter encryption password. If a password is not found, the component generates a random password.
578577

579-
Call [`audit_log_filter_encryption_set()`](#audit_log_filter_encryption_set) to set a specific password.
578+
Call [audit_log_encryption_password_set(new_password)](#audit_log_encryption_password_setnew_password) to set a specific password.
580579

581580

582581
### `audit_log_filter.prune_seconds`
@@ -600,8 +599,8 @@ A value greater than 0 enables pruning. An audit log filter file can be pruned a
600599

601600
To enable log pruning, you must set one of the following:
602601

603-
* Enable log rotation by setting [`audit_log_filter.rotate_on_size`](audit_log_filterrotate_on_size)
604-
* Add a value greater than 0 (zero) for either [`audit_log_filter.max_size`](audit_log_filtermax_size) or [`audit_log_filter.prune_seconds`](audit_log_filterprune_seconds)
602+
* Enable log rotation by setting [`audit_log_filter.rotate_on_size`](#audit_log_filterrotate_on_size)
603+
* Add a value greater than 0 (zero) for either [`audit_log_filter.max_size`](#audit_log_filtermax_size) or [`audit_log_filter.prune_seconds`](#audit_log_filterprune_seconds)
605604

606605

607606
### `audit_log_filter.read_buffer_size`
@@ -617,7 +616,7 @@ To enable log pruning, you must set one of the following:
617616

618617
This option is only supported for JSON-format files.
619618

620-
The size of the buffer for reading from the audit log filter file. The [`audit_log_filter_read()`](audit_log_filter_read) reads only from this buffer size.
619+
The size of the buffer for reading from the audit log filter file. The `audit_log_filter_read()` reads only from this buffer size.
621620

622621
### `audit_log_filter.rotate_on_size`
623622

@@ -672,7 +671,7 @@ Defines the Audit Log filter component's logging method. The valid values are th
672671
| Data type | String |
673672
| Default | LOG_USER |
674673

675-
Specifies the syslog `facility` value. The option has the same meaning as the appropriate parameter described in the [syslog(3) manual](https://linux.die.net/man/3/syslog).
674+
Specifies the syslog `facility` value. The option has the same meaning as the appropriate parameter described in the [syslog(3) manual](https://man7.org/linux/man-pages/man3/syslog.3.html).
676675

677676

678677
### `audit_log_filter.syslog_priority`
@@ -685,7 +684,7 @@ Specifies the syslog `facility` value. The option has the same meaning as the ap
685684
| Data type | String |
686685
| Default | LOG_INFO |
687686

688-
Defines the `priority` value for the syslog. The option has the same meaning as the appropriate parameter described in the [syslog(3) manual](https://linux.die.net/man/3/syslog).
687+
Defines the `priority` value for the syslog. The option has the same meaning as the appropriate parameter described in the [syslog(3) manual](https://man7.org/linux/man-pages/man3/syslog.3.html).
689688

690689
## Audit log filter status variables
691690

‎docs/data-masking-function-list.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -963,7 +963,7 @@ mysql> SELECT masking_dictionary_term_remove('trees','pine');
963963
| **Name** | **Details** |
964964
|---------------------------------------------------|-------------------------------------------------------|
965965
| [`dictionaries_flush_interval_seconds (integer, unsigned)`](#dictionaries_flush_interval_secondsinteger-unsigned) | The number of seconds between updates to the internal dictionary cache to match changes in the dictionaries table.|
966-
| [`masking_database(str)`](#masking_databasestr) | Set a different database name to use for the dictionaries table. |
966+
| [`masking_database(string)`](#masking_databasestring) | Set a different database name to use for the dictionaries table. |
967967

968968
### dictionaries_flush_interval_seconds(integer, unsigned)
969969

‎docs/data-masking-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ To fix this, you can use the new [`masking_dictionaries_flush()`](data-masking-f
3939

4040
The changes also affect how row-based replication works. When dictionary changes happen on the source server, they travel through the binary log to the replica server. While the replica applies these changes to its table correctly, the dictionary term cache doesn't update right away.
4141

42-
To handle this, there's a new component system variable called [`component_masking_functions.dictionaries_flush_interval_seconds()`](data-masking-function-list.html#dictionaries_flush_interval_secondsinteger-unsigned)
42+
To handle this, there's a new component system variable called [`component_masking_functions.dictionaries_flush_interval_seconds()`](data-masking-function-list.md#dictionaries_flush_interval_secondsinteger-unsigned)
4343

4444
By default, it's set to 0. When you set it higher, the system starts a background process that refreshes the cache at your specified interval. This helps replicas stay in sync after receiving binary log updates. The value specifies the number of seconds between each sync.
4545

‎docs/enforce-engine.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ This variable is not case sensitive.
3636

3737
## Example
3838

39-
Adding following option to [my.cnf](glossary.md#my.cnf) will start the server with InnoDB as enforced storage engine.
39+
Adding following option to [my.cnf](glossary.md#mycnf) will start the server with InnoDB as enforced storage engine.
4040

4141
```text
4242
enforce_storage_engine=InnoDB

‎docs/feature-comparison.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ compared to the standard *MySQL* database server:
6161
| Contention-Aware Transaction Scheduling | Yes | Yes |
6262
| Improved Scalability By Splitting Mutexes | Yes | No |
6363
| [Improved MEMORY Storage Engine](improved-memory-engine.md) | Yes | No |
64-
| [Improved Flushing](xtradb-performance-improvements.md#multi-threaded-flusher) | Yes | No |
64+
| [Improved Flushing](xtradb-performance-improvements.md#multi-threaded-lru-flusher) | Yes | No |
6565
| Parallel Doublewrite Buffer | Yes | Yes |
6666
| [Configurable Fast Index Creation](innodb-expanded-fast-index-creation.md) | Yes | No |
6767
| Per-Column Compression for VARCHAR/BLOB and JSON | Yes | No |

‎docs/index-info-schema-tables.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,25 @@
22

33
This is a list of the `INFORMATION_SCHEMA TABLES` that exist in Percona Server for MySQL with XtraDB. The entry for each table points to the page in the documentation where it’s described.
44

5-
* [INFORMATION_SCHEMA.CLIENT_STATISTICS](user-stats.md#client-statistics)
5+
* [INFORMATION_SCHEMA.CLIENT_STATISTICS](user-stats.md#information_schemaclient_statistics)
66

7-
* [INFORMATION_SCHEMA.GLOBAL_TEMPORARY_TABLES](user-stats.md#index-statistics)
7+
* [INFORMATION_SCHEMA.GLOBAL_TEMPORARY_TABLES](misc-info-schema-tables.md#information_schemaglobal_temporary_tables)
88

9-
* [INFORMATION_SCHEMA.INDEX_STATISTICS]
9+
* [INFORMATION_SCHEMA.INDEX_STATISTICS](user-stats.md#information_schemaindex_statistics)
1010

1111
* [PROCFS](procfs-plugin.md#procfs)
1212

13-
* [INFORMATION_SCHEMA.QUERY_RESPONSE_TIME](https://docs.percona.com/percona-server/5.7/diagnostics/response_time_distribution.html?h=information_schema+query_response_time#information_schemaquery_response_time)
13+
* [INFORMATION_SCHEMA.QUERY_RESPONSE_TIME](https://docs.percona.com/percona-server/5.7/diagnostics/response_time_distribution.html#query-response-time)
1414

15-
* [INFORMATION_SCHEMA.TABLE_STATISTICS](user-stats.md#table-statistics)
15+
* [INFORMATION_SCHEMA.TABLE_STATISTICS](user-stats.md#information_schematable_statistics)
1616

17-
* [INFORMATION_SCHEMA.TEMPORARY_TABLES](misc-info-schema-tables.md#id1)
17+
* [INFORMATION_SCHEMA.TEMPORARY_TABLES](misc-info-schema-tables.md#information_schematemporary_tables)
1818

19-
* THREAD_STATISTICS
19+
* [INFORMATION_SCHEMA.THREAD_STATISTICS](user-stats.md#information_schemathread_statistics)
2020

21-
* [INFORMATION_SCHEMA.USER_STATISTICS](user-stats.md#id3)
21+
* [INFORMATION_SCHEMA.USER_STATISTICS](user-stats.md#information_schemauser_statistics)
2222

23-
* XTRADB_INTERNAL_HASH_TABLES
23+
* [INFORMATION_SCHEMA.XTRADB_INTERNAL_HASH_TABLES](innodb-show-status.md#information_schemaxtradb_internal_hash_tables)
2424

25-
* XTRADB_READ_VIEW
25+
* [INFORMATION_SCHEMA.XTRADB_READ_VIEW](innodb-show-status.md#information_schemaxtradb_read_view)
2626

27-
* [INFORMATION_SCHEMA.XTRADB_RSEG](misc-info-schema-tables.md#xtradb-rseg)
28-
29-
* [INFORMATION_SCHEMA.XTRADB_ZIP_DICT](compressed-columns.md#xtradb-zip-dict)
30-
31-
* [INFORMATION_SCHEMA.XTRADB_ZIP_DICT_COLS](compressed-columns.md#xtradb-zip-dict-cols)

‎docs/jemalloc-profiling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ The following options are:
180180

181181
### jemalloc_profiling
182182

183-
Description: Enables jemalloc profiling. The variable requires [jemalloc_detected](#jemallocdetected).
183+
Description: Enables jemalloc profiling. The variable requires [jemalloc_detected](#jemalloc_detected).
184184

185185
* Command Line: –jemalloc_profiling[=(OFF|ON)]
186186

‎docs/ldap-authentication.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ If you installed either plugin at [server startup](#load-the-plugins-at-server-s
255255

256256
=== "Uninstall the simple LDAP authentication plugin"
257257

258-
If you installed the plugins at [runtime](#load-the-simple-ldap-authentication-plugin-at-runtime), run the following statements:
258+
If you installed the plugins at [runtime](#load-the-plugins-at-runtime), run the following statements:
259259

260260
```{.bash data-prompt="mysql>"}
261261
mysql> UNINSTALL PLUGIN authentication_ldap_simple;
@@ -265,7 +265,7 @@ If you installed either plugin at [server startup](#load-the-plugins-at-server-s
265265

266266
=== "Uninstall the SASL-based LDAP authentication plugin"
267267

268-
If you installed the plugins at [runtime](#load-the-sasl-based-ldap-authentication-plugin-at-runtime), run the following statements:
268+
If you installed the plugins at [runtime](#load-the-plugins-at-runtime), run the following statements:
269269

270270
```{.bash data-prompt="mysql>"}
271271
mysql> UNINSTALL PLUGIN authentication_ldap_sasl;

‎docs/manage-audit-log-filter.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ If automatic rotation is enabled, you can prune the log file. This pruning opera
1111

1212
## Manual log rotation
1313

14-
The default setting for [`audit_log_filter.rotate_on_size`](audit-log-filter-variables.md#audit_log_filter_rotate_on_size) is 1GB. If this option is set to `0`, the audit log filter component does not do an automatic rotation of the log file. You must do the rotation manually with this setting.
14+
The default setting for [`audit_log_filter.rotate_on_size`](audit-log-filter-variables.md#audit_log_filterrotate_on_size) is 1GB. If this option is set to `0`, the audit log filter component does not do an automatic rotation of the log file. You must do the rotation manually with this setting.
1515

1616
The `SELECT audit_log_rotate()` command renames the file and creates a new audit log filter file with the original name. You must have the `AUDIT_ADMIN` privilege.
1717

0 commit comments

Comments
 (0)