Skip to content

Commit e960e5e

Browse files
nook24nook24
committed
Add changelog
1 parent afbb6b8 commit e960e5e

File tree

4 files changed

+204
-13
lines changed

4 files changed

+204
-13
lines changed

‎config.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ top_menu:
5858
- { name: Getting Started, url: "/getting_started", icon: "fa fa-play", anchors: ["Overview", "Components", "Requirements", "Quick start", "Performance data"] }
5959
- { name: Broker Module, url: "/broker", icon: "fa fa-cogs", anchors: ["Overview", "Scale out to Multiple Nodes", "Supported Monitoring Tools", "Installation", "Broker Configuration", "OCSP and OCHP", "How to update", "Debug Broker Module"] }
6060
- { name: Legacy Broker Module, url: "/broker_old", icon: "fa fa-cogs", anchors: ["Overview", "Scale out to Multiple Nodes", "Supported Monitoring Tools", "Installation", "Broker Options", "OCSP and OCHP", "How to update", "Debug Broker Module"] }
61-
- { name: Worker, url: "/worker", icon: "fa fa-spinner", anchors: ["Overview", "Scale out to Multiple Nodes", "Requirements", "Installation", "Database", "Configuration", "Configure Performance Data", "Start Statusengine Worker", "Cleanup database", "Manage Cluster Nodes", "Get Metrics", "In-memory", "How to update", "Debugging"] }
61+
- { name: Worker, url: "/worker", icon: "fa fa-spinner", anchors: ["Overview", "Scale out to Multiple Nodes", "Requirements", "Installation", "Database", "Configuration", "Configure Performance Data", "Start Statusengine Worker", "Cleanup database", "Manage Cluster Nodes", "Get Metrics", "In-memory", "How to update", "Update to 3.7", "Debugging"] }
6262
- { name: Statusengine UI, url: "/ui", icon: "fa fa-desktop", anchors: ["Overview", "Features", "Installation", "Configuration", "First user", "HTTPS", "Apache Example Config", "Nginx Example Config", "PHP built-in server", "Manage users", "Ui Settings", "How to update"] }
6363
- { name: Tutorials, url: "/tutorials", icon: "fa fa-graduation-cap", anchors: [] }
6464
- { name: Demo, url: "https://demo.statusengine.org", icon: "fa fa-desktop", anchors: [] }

‎src/content/assets/img/roadmap/external_links.png

36.9 KB
Loading

‎src/content/roadmap.html

+115-11
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,128 @@
66

77

88
<h5 class="lineh"><span>Planed / In development</span></h2>
9-
<section id="module-4.0.0" class="doc-section">
10-
<h2 class="page-header"><a href="#module-4.0.0" class="anchor">Module 4.0.0</a></h2>
9+
<section id="whats-next" class="doc-section">
10+
<h2 class="page-header"><a href="#whats-next" class="anchor">Whats next</a></h2>
1111
<p>
1212
<ul>
13-
<li>Rewrite Statusengine Broker Module with C++</li>
14-
<li><i class="fa fa-check text-success"></i> Create new Repository <a href="https://github.com/statusengine/broker">https://github.com/statusengine/broker</a></li>
15-
<li><i class="fa fa-check text-success"></i> Add Gearman support</li>
16-
<li><i class="fa fa-check text-success"></i> Add RabbitMQ support</li>
17-
<li><i class="fa fa-check text-success"></i> Add config file support</li>
18-
<li><i class="fa fa-check text-success"></i> Create CI build process</li>
19-
<li>Process of check results</li>
20-
<li>Documentation</li>
13+
<li>For now Statusengine is feature complete. If you found an issue or have an feature request please create an issue at the corresponding GitHub repository
14+
<a href="https://github.com/statusengine/" target="_blank">https://github.com/statusengine/</a></li>
2115
</ul>
16+
<br />
2217
</p>
2318
</section>
2419

2520
<h5 class="lineh"><span>Changelog</span></h2>
2621

22+
<section id="worker-3.7.0" class="doc-section">
23+
<h2 class="page-header"><a href="#worker-3.7.0" class="anchor">Worker 3.7.0</a></h2>
24+
<p>
25+
26+
<div class="callout callout-warning">
27+
<h4>MySQL schema changes</h4>
28+
<p>
29+
Statusengine 3.7 contains major changes to the MySQL database schema.
30+
Please follow the
31+
<a href="/worker#update-to-3.7">Update to 3.7 instructions</a>
32+
first.
33+
</p>
34+
</div>
35+
36+
<ul>
37+
<li>
38+
Add update statements for MySQL
39+
<a href="https://github.com/statusengine/worker/issues/24" target="_blank">
40+
#24
41+
</a>
42+
<a href="https://github.com/statusengine/worker/issues/28" target="_blank">
43+
#28
44+
</a> - thanks to <a href="https://github.com/ibering" target="_blank">@ibering</a>
45+
</li>
46+
<li>
47+
Implement passing of external commands through Statusengine C++ Broker
48+
</li>
49+
<li>
50+
Added support for Elasticsearch 7.x
51+
</li>
52+
<li>
53+
Add option to set mysql encoding
54+
- thanks to <a href="https://github.com/ibering" target="_blank">@ibering</a>
55+
</li>
56+
<li>
57+
Fix for composer 2.0
58+
</li>
59+
</ul>
60+
</p>
61+
</section>
62+
63+
<section id="module-4.0.2" class="doc-section">
64+
<h2 class="page-header"><a href="#module-4.0.2" class="anchor">Module 4.0.2</a></h2>
65+
<p>
66+
<ul>
67+
<li>
68+
Gearman support
69+
</li>
70+
<li>
71+
RabbitMQ support
72+
</li>
73+
<li>
74+
Bulk messages in queue
75+
</li>
76+
<li>
77+
Configuration via config file
78+
</li>
79+
<li>
80+
Modern C++ code
81+
</li>
82+
<li>
83+
Resolve UTF8 issues
84+
</li>
85+
<li>
86+
Processing external commands (no more nagios.cmd / naemon.qh needed)
87+
</li>
88+
</ul>
89+
</p>
90+
</section>
91+
92+
<section id="ui-3.7.0" class="doc-section">
93+
<h2 class="page-header"><a href="#ui-3.7.0" class="anchor">UI 3.7.0</a></h2>
94+
<p>
95+
<ul>
96+
<li>
97+
Switch package manager from bower to npm
98+
</li>
99+
<li>
100+
Updated all JavaScript dependencies
101+
</li>
102+
<li>
103+
Added support for Elasticsearch 7.x
104+
</li>
105+
<li>
106+
Display username if the user is logged in <a href="https://github.com/statusengine/interface/issues/38" target="_blank">
107+
#38
108+
</a>
109+
</li>
110+
<li>
111+
Add support for /sub-subdirectories/ in the URL <a href="https://github.com/statusengine/interface/issues/36" target="_blank">
112+
#36
113+
</a>
114+
</li>
115+
<li>
116+
Add option to set mysql encoding
117+
- thanks to <a href="https://github.com/ibering" target="_blank">@ibering</a>
118+
</li>
119+
<li>
120+
Add support for external links <a href="https://github.com/statusengine/interface/issues/44" target="_blank">
121+
#44
122+
</a>
123+
<center>
124+
<img src="{{ site.url }}/assets/img/roadmap/external_links.png" class="img-responsive" alt="Statusengine UI Night Mode"/>
125+
</center>
126+
</li>
127+
</ul>
128+
</p>
129+
</section>
130+
27131
<section id="ui-3.4.0" class="doc-section">
28132
<h2 class="page-header"><a href="#ui-3.4.0" class="anchor">UI 3.4.0</a></h2>
29133
<p>
@@ -57,7 +161,7 @@ <h2 class="page-header"><a href="#ui-3.4.0" class="anchor">UI 3.4.0</a></h2>
57161
</p>
58162

59163
</p>
60-
</section>
164+
</section>
61165

62166
<section id="module-3.0.2" class="doc-section">
63167
<h2 class="page-header"><a href="#module-3.0.2" class="anchor">Module 3.0.2</a></h2>

‎src/content/worker.html

+88-1
Original file line numberDiff line numberDiff line change
@@ -492,6 +492,17 @@ <h2 class="page-header"><a href="#in-memory" class="anchor">In-memory</a></h2>
492492

493493
<section id="how-to-update" class="doc-section">
494494
<h2 class="page-header"><a href="#how-to-update" class="anchor">How to update</a></h2>
495+
496+
<div class="callout callout-warning">
497+
<h4>Updating from a version < 3.7 ?</h4>
498+
<p>
499+
Statusengine 3.7 contains major changes to the MySQL database schema.
500+
Please follow the
501+
<a href="#update-to-3.7">Update to 3.7 instructions</a>
502+
first.
503+
</p>
504+
</div>
505+
495506
<p>Make sure you have installed the php extension <code>bcmath</code>. You can check if the extension is loaded using this command: <code>php -m |grep bcmath</code>.</p>
496507
<p>
497508
If you had installed Statusengine through <code>git</code>, the update will be done quickly.
@@ -517,9 +528,16 @@ <h2 class="page-header"><a href="#how-to-update" class="anchor">How to update</a
517528
<li>
518529
Update your database (if required)
519530
<br />
531+
<b>MySQL Users:</b>
532+
<br />
533+
Statusengine will handle any schema updates automatically. When executed with <code>--dry-run</code> the update statements will only be print to the CLI but not executed.
534+
<pre>/opt/statusengine/worker/bin/Console.php database --update</pre>
535+
<br />
536+
<b>CrateDB Users:</b>
537+
<br />
520538
Check the path <code>/opt/statusengine/worker/<a href="https://github.com/statusengine/worker/tree/master/lib" target="_blank">lib</a></code> for any database update files.
521539
<br />
522-
If an database schema update is available, the file name would be like <code>mysql_3.1.0_TO_3.2.0.sql</code> for example.
540+
If an database schema update is available, the file name would be like <code>crateDB_3.1.0_TO_3.2.0.sql</code> for example.
523541
<br />
524542
Execute every sql file in the right order!
525543
<br />
@@ -545,6 +563,75 @@ <h2 class="page-header"><a href="#how-to-update" class="anchor">How to update</a
545563
</p>
546564
</section>
547565

566+
<section id="update-to-3.7" class="doc-section">
567+
<h2 class="page-header"><a href="#update-to-3.7" class="anchor">Update to 3.7</a></h2>
568+
569+
This update instructions only affects MySQL users. If you are using CrateDB as storage backend, please continue with the
570+
<a href="#how-to-update">How to update</a> guide.
571+
572+
With Statusengine 3.7 new Primary Keys got added to the MySQL database schema. This speeds up select performance by a lot.
573+
<br />
574+
Unfortunately it could take a while to add the new columns and primary keys depending on the size of the database.
575+
576+
<ol>
577+
<li>
578+
Stop Statusengine Worker
579+
<pre>{[{commands[selectedOs].stopStatusengineWorker}]}</pre>
580+
</li>
581+
582+
<li>
583+
Create backup of your files
584+
<pre>cp -r /opt/statusengine/worker /some/backup/path</pre>
585+
</li>
586+
587+
<li>
588+
Create backup of your database (Make sure you have enough disk space available)
589+
<pre>mysqldump -u statusengine -p --databases statusengine --flush-privileges --single-transaction --triggers --routines --no-tablespaces --events --hex-blob --ignore-table=statusengine.statusengine_perfdata > /opt/statusengine/statusengine_dump.sql</pre>
590+
</li>
591+
592+
<li>
593+
Update your local files
594+
<pre>cd /opt/statusengine/worker
595+
git pull origin master
596+
composer update</pre>
597+
</li>
598+
599+
<li>
600+
Check for configuration changes
601+
<br />
602+
You old configuration is still loaded. Statusengine Worker defines default values for each configuration variable.
603+
<br />
604+
Nevertheless you should compare your current configuration with the new example configuration file for new interessing configuration options.
605+
<pre>vimdiff /opt/statusengine/worker/etc/config.yml /opt/statusengine/worker/etc/config.yml.example</pre>
606+
</li>
607+
608+
<li>
609+
Add new primary keys to database
610+
<br />
611+
This will take a while. running the command via <i>tmux</i> or <i>screen</i> is recommended
612+
<br />
613+
614+
<pre>mysql -u statusengine -p statusengine < /opt/statusengine/worker/lib/mysql_update.sql</pre>
615+
</li>
616+
617+
<li>
618+
Update database schema
619+
<br />
620+
This will take a while. running the command via <i>tmux</i> or <i>screen</i> is recommended
621+
<br />
622+
623+
<pre>/opt/statusengine/worker/bin/Console.php database --update</pre>
624+
</li>
625+
626+
<li>
627+
Start Statusengine Worker
628+
<pre>{[{commands[selectedOs].startStatusengineWorker}]}</pre>
629+
</li>
630+
631+
</ol>
632+
633+
</section>
634+
548635
<section id="debugging" class="doc-section">
549636
<h2 class="page-header"><a href="#debugging" class="anchor">Debugging</a></h2>
550637
<p>

0 commit comments

Comments
 (0)