feat(api): add eventlog listing #8381

victorvassilev · 2020-02-28T15:02:33Z

Description

Add endpoint to allow retrieving event timeline for hosts and services

Fixes # MON-4866,MON-4867

Type of change

Patch fixing an issue (non-breaking change)
New functionality (non-breaking change)
Breaking change (patch or feature) that might cause side effects breaking part of the Software
Updating documentation (missing information, typo...)

Target serie

How this pull request can be tested ?

Visit the endpoint using GET:

http://host/centreon/api/beta/monitoring/hosts/14/services/19/timeline
http://host/centreon/api/beta/monitoring/hosts/14/timeline

Checklist

Community contributors & Centreon team

I followed the coding style guidelines provided by Centreon
I have commented my code, especially new classes, functions or any legacy code modified. (docblock)
I have commented my code, especially hard-to-understand areas of the PR.
I have made corresponding changes to the documentation.
I have rebased my development branch on the base branch (master, maintenance).

Centreon team only

I have made sure that the unit tests related to the story are successful.
I have made sure that unit tests cover 80% of the code written for the story.
I have made sure that acceptance tests related to the story are successful (local and CI)

Resolves: MON-4866, MON-4867

…ntreon/centreon into MON-4866-add-eventlog-listing

…TranslateSortParameterToSql

* fix(ldap): use define user member_attribute var * fix(code): use PSR2

…8385)

* fix(code): dedicated meta event console does not exist anymore * fix(code): scheduling queue console does not exist anymore * fix(code): merge some cases Co-authored-by: Colin Gagnaire <cgagnaire@centreon.com>

Refs: MON-7944

* feat(doc): update the API documentation Resolve MON-4887 * fix(doc): apply feedback from PR Resolve MON-4887

src/Centreon/Domain/Monitoring/Entity/DowntimeEventObject.php

src/Centreon/Domain/Monitoring/Interfaces/EventObjectInterface.php

src/Centreon/Domain/Monitoring/Interfaces/TimelineRepositoryInterface.php

src/Centreon/Infrastructure/Monitoring/TimelineRepositoryRDB.php

kduret · 2020-03-06T07:04:19Z

src/Centreon/Infrastructure/Monitoring/TimelineRepositoryRDB.php

+    protected function generateCommentsQuery(StatementCollector $collector, int $hostId, int $serviceId = null): string
+    {
+        $sql = "SELECT
+		CONCAT('C', c.comment_id) AS `eventId`,


IMHO, eventId should be an integer from only eventId
The unique id will be the association between eventType and eventId

this way it wouldn't be unique :) we just needed 1 field that is unique for every timeline set of data

We can do a unique identifier based on two fields
For instance, if we want to get information of a specific event, the controller will look like:
monitoring/events/{type}/{id}

I agree with you, but this 'eventId' property does not need to be used if FE don't need it, and can be removed later if we decide it is useless. For now it does not hurt to have it, because I believe every listing endpoint had to have unique identifier for each row of returned info (due to FE requirements). If that is not the case I can always just omit it from the return of the endpoint. It does not create extra load, it does not mess with any business logic, so in a future refactor we can just remove it easily.

src/Centreon/Infrastructure/Monitoring/TimelineRepositoryRDB.php

Co-Authored-By: Kevin Duret <kduret@centreon.com>

…terface.php Co-Authored-By: Kevin Duret <kduret@centreon.com>

….php Co-Authored-By: Kevin Duret <kduret@centreon.com>

Resolves: MON-4866, MON-4867

Co-Authored-By: Kevin Duret <kduret@centreon.com>

…terface.php Co-Authored-By: Kevin Duret <kduret@centreon.com>

….php Co-Authored-By: Kevin Duret <kduret@centreon.com>

…ntreon/centreon into MON-4866-add-eventlog-listing

Thebarda and others added 5 commits February 28, 2020 11:24

Adapt font regexp path for Windows (#8375)

80add3b

enh(apiv2): add event listing for hosts and services

036f6f0

Resolves: MON-4866, MON-4867

enh(apiv2): add event listing for hosts and services

748d8ea

Resolves: MON-4866, MON-4867

fix(doc): regenerate html for doc

e793c0e

Merge branch 'MON-4866-add-eventlog-listing' of https://github.com/ce…

915762f

…ntreon/centreon into MON-4866-add-eventlog-listing

victorvassilev requested review from vhr, kduret and callapa and removed request for vhr February 28, 2020 15:04

victorvassilev changed the base branch from master to MON-4789-unified-view February 28, 2020 15:12

bdauria and others added 12 commits February 28, 2020 16:13

feat(ui): Implement Resources listing (#8371)

33c0fe1

fix(tests): update error message on unit test

9e5b802

Fix the search parameter 'IN' (#8380)

85a8b6c

fix(doc): fix scrollbar issue in API documentation (#8378)

9972d4c

feat(build): stash git sources for Sonar analysis.

4245032

feat(ui): Implement Unified view search (#8382)

0d3c51c

feat(build): fail build on front-end style errors.

07c7e2f

enh(doc): update docblock in interface

40443e8

fix: fix ESLint warnings

a3e7713

Merge branch 'master' into MON-4789-unified-view

f4463cb

doc(api): document how to use search parameter with API (#8376)

fd1f005

Merge branch 'master' into MON-4789-unified-view

4e26b51

cgagnaire added area/api kind/feature pr/internal-rd PR made by the Centreon R&D Team labels Mar 4, 2020

vhr and others added 4 commits March 5, 2020 09:41

fix(test): improve unit test SqlRequestParametersTranslatorTest::test…

fc38f12

…TranslateSortParameterToSql

fix(configuration): export hosts geo_coords to remote server (#8390)

23166d1

fix(ldap): use define user member_attribute var (#8287)

83fff4a

* fix(ldap): use define user member_attribute var * fix(code): use PSR2

feat(ui): Implement Unified view downtime and acknowledge tooltips (#…

3a97ce2

…8385)

fix(code): Clean switch case service monitoring (#8285)

75128bf

* fix(code): dedicated meta event console does not exist anymore * fix(code): scheduling queue console does not exist anymore * fix(code): merge some cases Co-authored-by: Colin Gagnaire <cgagnaire@centreon.com>

kduret changed the title ~~Mon 4866 add eventlog listing~~ feat(api): add eventlog listing Mar 5, 2020

kduret and others added 5 commits March 5, 2020 12:04

fix(remote-server): fix import with strict mode (#7944)

34c6b66

Refs: MON-7944

doc(api): document how to generate html api documentation (#8394)

b143520

Merge branch 'master' into MON-4789-unified-view

45793fa

feat(doc): update the API documentation (#8393)

a87f83a

* feat(doc): update the API documentation Resolve MON-4887 * fix(doc): apply feedback from PR Resolve MON-4887

fix(doc): remove again api html documentation

c01eb93

kduret reviewed Mar 6, 2020

View reviewed changes

victorvassilev and others added 3 commits March 6, 2020 10:50

Update src/Centreon/Domain/Monitoring/Entity/DowntimeEventObject.php

50ed470

Co-Authored-By: Kevin Duret <kduret@centreon.com>

Update src/Centreon/Domain/Monitoring/Interfaces/TimelineRepositoryIn…

99987ce

…terface.php Co-Authored-By: Kevin Duret <kduret@centreon.com>

Update src/Centreon/Domain/Monitoring/Interfaces/EventObjectInterface…

38983b7

….php Co-Authored-By: Kevin Duret <kduret@centreon.com>

victorvassilev requested a review from kduret March 6, 2020 08:53

kduret approved these changes Mar 6, 2020

View reviewed changes

bdauria and others added 10 commits March 6, 2020 11:41

Update package-lock

a06651f

enh(apiv2): add event listing for hosts and services

f9d30ea

Resolves: MON-4866, MON-4867

fix(doc): regenerate html for doc

d4397aa

fix(tests): update error message on unit test

64b829f

enh(doc): update docblock in interface

8e07ec2

Update src/Centreon/Domain/Monitoring/Entity/DowntimeEventObject.php

28a304d

Co-Authored-By: Kevin Duret <kduret@centreon.com>

Update src/Centreon/Domain/Monitoring/Interfaces/TimelineRepositoryIn…

d981c56

…terface.php Co-Authored-By: Kevin Duret <kduret@centreon.com>

Update src/Centreon/Domain/Monitoring/Interfaces/EventObjectInterface…

d6ac24e

….php Co-Authored-By: Kevin Duret <kduret@centreon.com>

resolve conflict with html doc

c1b4cd6

Merge branch 'MON-4866-add-eventlog-listing' of https://github.com/ce…

60cb7cf

…ntreon/centreon into MON-4866-add-eventlog-listing

vhr approved these changes Mar 6, 2020

View reviewed changes

victorvassilev merged commit 2467ebd into MON-4789-unified-view Mar 6, 2020

victorvassilev deleted the MON-4866-add-eventlog-listing branch March 6, 2020 12:52

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(api): add eventlog listing #8381

feat(api): add eventlog listing #8381

victorvassilev commented Feb 28, 2020

kduret Mar 6, 2020

victorvassilev Mar 6, 2020

kduret Mar 6, 2020

victorvassilev Mar 6, 2020

feat(api): add eventlog listing #8381

feat(api): add eventlog listing #8381

Conversation

victorvassilev commented Feb 28, 2020

Description

Type of change

Target serie

How this pull request can be tested ?

Checklist

Community contributors & Centreon team

Centreon team only

kduret Mar 6, 2020

Choose a reason for hiding this comment

victorvassilev Mar 6, 2020

Choose a reason for hiding this comment

kduret Mar 6, 2020

Choose a reason for hiding this comment

victorvassilev Mar 6, 2020

Choose a reason for hiding this comment