Skip to content

Commit

Permalink
Account Redis' trademark policy (#1008)
Browse files Browse the repository at this point in the history
  • Loading branch information
nilmerg authored Apr 11, 2024
2 parents 787649f + 11ce749 commit 4c335d2
Show file tree
Hide file tree
Showing 11 changed files with 37 additions and 23 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@
Icinga DB is a set of components for publishing, synchronizing and
visualizing monitoring data in the Icinga ecosystem, consisting of:

* Icinga DB Web which connects to both a Redis server and a database to view and work with
* Icinga DB Web which connects to both a Redis®[\*](doc/TRADEMARKS.md#redis) server and a database to view and work with
most up-to-date monitoring data
* Icinga 2 with its [Icinga DB feature](https://icinga.com/docs/icinga-2/latest/doc/14-features/#icinga-db) enabled,
responsible for publishing the data to the Redis server, i.e. configuration and its runtime updates, check results, state changes,
downtimes, acknowledgements, notifications, and other events such as flapping
responsible for publishing the data to the Redis® server, i.e. configuration and its runtime updates, check results,
state changes, downtimes, acknowledgements, notifications, and other events such as flapping
* And the [Icinga DB daemon](https://icinga.com/docs/icinga-db),
which synchronizes the data between the Redis server and the database
which synchronizes the data between the Redis® server and the database

![Icinga DB Architecture](doc/res/icingadb-architecture.png)

Expand Down
7 changes: 4 additions & 3 deletions doc/01-About.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@
Icinga DB is a set of components for publishing, synchronizing and
visualizing monitoring data in the Icinga ecosystem, consisting of:

* Icinga DB Web which connects to both a Redis server and a database to view and work with monitoring data
* Icinga DB Web which connects to both a Redis®[\*](TRADEMARKS.md#redis) server and
a database to view and work with monitoring data
* Icinga 2 with its [Icinga DB feature](https://icinga.com/docs/icinga-2/latest/14-features/#icinga-db) enabled,
responsible for publishing monitoring configuration, check results,
states changes and history items to the Redis server
states changes and history items to the Redis® server
* And the [Icinga DB daemon](https://icinga.com/docs/icinga-db/latest/01-About/),
which synchronizes monitoring data between the Redis server and the database
which synchronizes monitoring data between the Redis® server and the database

![Icinga DB Architecture](res/icingadb-architecture.png)

Expand Down
8 changes: 4 additions & 4 deletions doc/03-Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,17 @@ Connection configuration for the database to which Icinga DB synchronizes monito
2. Configure the resource you just created as the database connection for the Icinga DB Web module using the
`Configuration → Modules → icingadb → Database` menu.

## Redis Configuration
## Redis® Configuration

Connection configuration for the Redis server where Icinga 2 writes check results.
Connection configuration for the Redis® server where Icinga 2 writes check results.
This data is used to display the latest state information in Icinga DB Web.

1. Configure the connection to the Redis server through the `Configuration → Modules → icingadb → Redis` menu.
1. Configure the connection to the Redis® server through the `Configuration → Modules → icingadb → Redis` menu.

!!! info

If you are running a high-availability Icinga 2 setup,
also configure the secondary master's Redis connection details.
also configure the secondary master's Redis® connection details.
Icinga DB Web then uses this connection if the primary one is not available.

## Command Transport Configuration
Expand Down
13 changes: 13 additions & 0 deletions doc/TRADEMARKS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Third-party Trademarks

All trademarks, logos, and brand names are the property of their respective owners.
Any mention of company, product, or service names in our documentations, product descriptions,
or websites is solely for identification purposes. The use of these names, trademarks,
and brands does not imply endorsement. This document acknowledges trademarks of companies and products,
which are the property of their respective owners, whether registered or unregistered.

## Redis®

Redis is a registered trademark of Redis Ltd. Any rights therein are reserved to Redis Ltd.
Any use by Icinga GmbH is for referential purposes only and does not indicate any sponsorship,
endorsement or affiliation between Redis and Icinga GmbH.
Binary file modified doc/res/icingadb-architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/res/icingadb-web.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions library/Icingadb/ProvidedHook/ApplicationState.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ public function collectMessages()
$this->addError(
'icingadb/redis-down',
$downSince,
sprintf(t("Can't connect to Icinga Redis: %s"), $e->getMessage())
sprintf(t("Can't connect to Redis: %s"), $e->getMessage())
);

return;
Expand Down Expand Up @@ -89,7 +89,7 @@ public function collectMessages()
$this->addError(
'icingadb/redis-outdated',
$lastIcingaHeartbeat,
t('Icinga Redis is outdated. Make sure Icinga 2 is running and connected to Redis.')
t('Redis is outdated. Make sure Icinga 2 is running and connected to Redis.')
);

break;
Expand Down
10 changes: 5 additions & 5 deletions library/Icingadb/ProvidedHook/RedisHealth.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ class RedisHealth extends HealthHook

public function getName(): string
{
return 'Icinga Redis';
return 'Redis';
}

public function checkHealth()
Expand All @@ -32,7 +32,7 @@ public function checkHealth()
if ($instance === null) {
$this->setState(self::STATE_UNKNOWN);
$this->setMessage(t(
'Can\'t check Icinga Redis: Icinga DB is not running or not writing into the database'
'Can\'t check Redis: Icinga DB is not running or not writing into the database'
. ' (make sure the icinga feature "icingadb" is enabled)'
));

Expand All @@ -42,14 +42,14 @@ public function checkHealth()
$outdatedDbHeartbeat = $instance->heartbeat->getTimestamp() < time() - 60;
if (! $outdatedDbHeartbeat || $instance->heartbeat->getTimestamp() <= $lastIcingaHeartbeat) {
$this->setState(self::STATE_OK);
$this->setMessage(t('Icinga Redis available and up to date.'));
$this->setMessage(t('Redis available and up to date.'));
} elseif ($instance->heartbeat->getTimestamp() > $lastIcingaHeartbeat) {
$this->setState(self::STATE_CRITICAL);
$this->setMessage(t('Icinga Redis outdated. Make sure Icinga 2 is running and connected to Redis.'));
$this->setMessage(t('Redis outdated. Make sure Icinga 2 is running and connected to Redis.'));
}
} catch (Exception $e) {
$this->setState(self::STATE_CRITICAL);
$this->setMessage(sprintf(t("Can't connect to Icinga Redis: %s"), $e->getMessage()));
$this->setMessage(sprintf(t("Can't connect to Redis: %s"), $e->getMessage()));
}
}
}
4 changes: 2 additions & 2 deletions library/Icingadb/Setup/RedisPage.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ class RedisPage extends Form
public function init()
{
$this->setName('setup_icingadb_redis');
$this->setTitle(t('Icinga DB Redis'));
$this->setTitle(t('Redis'));
$this->addDescription(t(
'Please fill out the connection details to access the Icinga DB Redis.'
'Please fill out the connection details to access the Redis server.'
));
$this->setValidatePartial(true);
}
Expand Down
4 changes: 2 additions & 2 deletions library/Icingadb/Setup/RedisStep.php
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ public function getSummary()
$topic = new HtmlElement('div', Attributes::create(['class' => 'topic']));
$topic->addHtml(new HtmlElement('p', null, Text::create(mt(
'icingadb',
'The Icinga DB Redis will be accessed using the following connection details:'
'Redis will be accessed using the following connection details:'
))));

$primaryOptions = new Table();
Expand Down Expand Up @@ -178,7 +178,7 @@ public function getSummary()

$summary = new HtmlDocument();
$summary->addHtml(
new HtmlElement('h2', null, Text::create(mt('icingadb', 'Icinga DB Redis'))),
new HtmlElement('h2', null, Text::create(mt('icingadb', 'Redis'))),
$topic
);

Expand Down
2 changes: 1 addition & 1 deletion library/Icingadb/Widget/ItemList/StateList.php
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ protected function assemble(): void

if ($this->data instanceof VolatileStateResults && $this->data->isRedisUnavailable()) {
$this->prependWrapper((new HtmlDocument())->addHtml(new Notice(
t('Icinga Redis is currently unavailable. The shown information might be outdated.')
t('Redis is currently unavailable. The shown information might be outdated.')
)));
}
}
Expand Down

0 comments on commit 4c335d2

Please sign in to comment.