Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closes #980 - Extending the alerting API to reload kapacitor tasks due to changed alerting rules #982

Merged
merged 4 commits into from
Feb 2, 2021
Merged

Closes #980 - Extending the alerting API to reload kapacitor tasks due to changed alerting rules #982

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
748a20c
Extending the alerting API to reload kapacitor tasks due to changed a…
Patrick-Eichhorn Jan 26, 2021
6c0c235
Implemented review comments
Patrick-Eichhorn Jan 28, 2021
18bbcb0
Implemented review comments
Patrick-Eichhorn Jan 29, 2021
e4d6b0b
added more information about reloading tasks
Patrick-Eichhorn Feb 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 7 additions & 11 deletions ...er/src/main/java/rocks/inspectit/ocelot/rest/alert/kapacitor/KapacitorTaskController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,7 @@ public KapacitorTaskController(InspectitServerSettings settings) {
@ApiOperation(value = "Provides a list with basic information about each kapacitor task. Only tasks based on templates will be listed.")
@GetMapping("/alert/kapacitor/tasks")
public List<Task> getAllTasks() {
ObjectNode response = kapacitor()
.getForEntity("/kapacitor/v1/tasks", ObjectNode.class)
.getBody();
ObjectNode response = kapacitor().getForEntity("/kapacitor/v1/tasks", ObjectNode.class).getBody();

return StreamSupport.stream(response.path("tasks").spliterator(), false)
.map(Task::fromKapacitorResponse)
Expand All @@ -39,8 +37,7 @@ public List<Task> getAllTasks() {

@GetMapping("/alert/kapacitor/tasks/{taskId}")
public Task getTask(@PathVariable @ApiParam("The id of the task to query") String taskId) {
ObjectNode response = kapacitor()
.getForEntity("/kapacitor/v1/tasks/{taskId}", ObjectNode.class, taskId)
ObjectNode response = kapacitor().getForEntity("/kapacitor/v1/tasks/{taskId}", ObjectNode.class, taskId)
.getBody();

return Task.fromKapacitorResponse(response);
Expand All @@ -50,8 +47,7 @@ public Task getTask(@PathVariable @ApiParam("The id of the task to query") Strin
@ApiOperation(value = "Inserts a new Kapacitor task")
@PostMapping("/alert/kapacitor/tasks")
public Task addTask(@RequestBody Task task) {
ObjectNode response = kapacitor()
.postForEntity("/kapacitor/v1/tasks", task.toKapacitorRequest(), ObjectNode.class)
ObjectNode response = kapacitor().postForEntity("/kapacitor/v1/tasks", task.toKapacitorRequest(), ObjectNode.class)
.getBody();

return Task.fromKapacitorResponse(response);
Expand All @@ -60,10 +56,10 @@ public Task addTask(@RequestBody Task task) {
@Secured(UserRoleConfiguration.WRITE_ACCESS_ROLE)
@ApiOperation(value = "Updates one or more settings of a kapacitor task")
@PatchMapping("/alert/kapacitor/tasks/{taskId}")
public Task updateTask(@PathVariable @ApiParam("The id of the task to update") String taskId,
@RequestBody Task task) {
ObjectNode response = kapacitor()
.patchForObject("/kapacitor/v1/tasks/{taskId}", task.toKapacitorRequest(), ObjectNode.class, taskId);
public Task updateTask(@PathVariable @ApiParam("The id of the task to update") String taskId, @RequestBody Task task) {
ObjectNode response = kapacitor().patchForObject("/kapacitor/v1/tasks/{taskId}", task.toKapacitorRequest(), ObjectNode.class, taskId);
ObjectNode responseReload = kapacitor().patchForObject("/kapacitor/v1/templates/{templateID}", task.toKapacitorRequestTemplateUpdate(), ObjectNode.class, task
.getTemplate());

return Task.fromKapacitorResponse(response);
}
Expand Down
12 changes: 12 additions & 0 deletions ...igurationserver/src/main/java/rocks/inspectit/ocelot/rest/alert/kapacitor/model/Task.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,18 @@ public ObjectNode toKapacitorRequest() {

}

/**
* @return a JSON-Object which can be used for updating the template in PATCH request to kapacitor
*/
public ObjectNode toKapacitorRequestTemplateUpdate() {
ObjectMapper mapper = new ObjectMapper();
ObjectNode result = mapper.createObjectNode();
result.put("id", template);

return result;

}

public static Task fromKapacitorResponse(JsonNode task) {
Task.TaskBuilder builder = Task.builder()
.id(task.path("id").asText())
Expand Down
178 changes: 65 additions & 113 deletions ...rc/test/java/rocks/inspectit/ocelot/rest/alert/kapacitor/KapacitorTaskControllerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,32 +47,27 @@ void tasksListedCorrectly() {
assertThat(task.getTemplate()).isEqualTo("my_template");
assertThat(task.getDescription()).isNull();
assertThat(task.getTopic()).isNull();
assertThat(task.getVars()).containsExactlyInAnyOrder(
TemplateVariable.builder()
.name("some_string")
.type("string")
.value("test")
.description("")
.build(),
TemplateVariable.builder()
.name("some_float")
.type("float")
.value(4242.0)
.description("")
.build(),
TemplateVariable.builder()
.name("some_int")
.type("int")
.value(42.0)
.description("")
.build(),
TemplateVariable.builder()
.name("some_dur")
.type("duration")
.value("2h")
.description("")
.build()
);
assertThat(task.getVars()).containsExactlyInAnyOrder(TemplateVariable.builder()
.name("some_string")
.type("string")
.value("test")
.description("")
.build(), TemplateVariable.builder()
.name("some_float")
.type("float")
.value(4242.0)
.description("")
.build(), TemplateVariable.builder()
.name("some_int")
.type("int")
.value(42.0)
.description("")
.build(), TemplateVariable.builder()
.name("some_dur")
.type("duration")
.value("2h")
.description("")
.build());

});
assertThat(result).anySatisfy(task -> {
Expand All @@ -86,14 +81,12 @@ void tasksListedCorrectly() {
assertThat(task.getTemplate()).isEqualTo("some_template");
assertThat(task.getDescription()).isEqualTo("My task description");
assertThat(task.getTopic()).isEqualTo("my_topic");
assertThat(task.getVars()).containsExactlyInAnyOrder(
TemplateVariable.builder()
.name("some_string")
.type("string")
.value("test")
.description("")
.build()
);
assertThat(task.getVars()).containsExactlyInAnyOrder(TemplateVariable.builder()
.name("some_string")
.type("string")
.value("test")
.description("")
.build());

});

Expand Down Expand Up @@ -122,14 +115,12 @@ void conflictingTemplateDefinitions() {
assertThat(task.getTemplate()).isEqualTo("other_template");
assertThat(task.getDescription()).isEqualTo("My task description");
assertThat(task.getTopic()).isEqualTo("my_topic");
assertThat(task.getVars()).containsExactlyInAnyOrder(
TemplateVariable.builder()
.name("some_string")
.type("string")
.value("test")
.description("")
.build()
);
assertThat(task.getVars()).containsExactlyInAnyOrder(TemplateVariable.builder()
.name("some_string")
.type("string")
.value("test")
.description("")
.build());

mockKapacitor.verify();
}
Expand All @@ -140,20 +131,11 @@ class AddTasks {

@Test
void addWithTemplate() {
Task toAdd = Task.builder()
.id("my_task")
.template("blub")
.build();
Task toAdd = Task.builder().id("my_task").template("blub").build();

mockKapacitor.expect(requestTo("/kapacitor/v1/tasks"))
.andExpect(method(HttpMethod.POST))
.andExpect(content().json(
"{" +
"\"id\" : \"my_task\"," +
"\"template-id\" : \"blub\"," +
"\"vars\" : { \"inspectit_template_reference\" : {\"type\" : \"string\", \"value\" : \"blub\"} }" +
"}"
, true))
.andExpect(content().json("{" + "\"id\" : \"my_task\"," + "\"template-id\" : \"blub\"," + "\"vars\" : { \"inspectit_template_reference\" : {\"type\" : \"string\", \"value\" : \"blub\"} }" + "}", true))
.andRespond(withSuccess(getTestJson("tasks_conflicting_template.json"), MediaType.APPLICATION_JSON));

Task result = controller.addTask(toAdd);
Expand All @@ -177,15 +159,7 @@ void addWithDescriptionAndVariable() {

mockKapacitor.expect(requestTo("/kapacitor/v1/tasks"))
.andExpect(method(HttpMethod.POST))
.andExpect(content().json(
"{" +
"\"id\" : \"my_task\"," +
"\"vars\" : { " +
"\"inspectit_template_description\" : {\"type\" : \"string\", \"value\" : \"blub\"}, " +
"\"my_dur\" : {\"type\" : \"duration\", \"value\" : 7000000000} " +
"}" +
"}"
, true))
.andExpect(content().json("{" + "\"id\" : \"my_task\"," + "\"vars\" : { " + "\"inspectit_template_description\" : {\"type\" : \"string\", \"value\" : \"blub\"}, " + "\"my_dur\" : {\"type\" : \"duration\", \"value\" : 7000000000} " + "}" + "}", true))
.andRespond(withSuccess(getTestJson("tasks_conflicting_template.json"), MediaType.APPLICATION_JSON));

Task result = controller.addTask(toAdd);
Expand All @@ -197,23 +171,11 @@ void addWithDescriptionAndVariable() {

@Test
void addWithTopicAndStatus() {
Task toAdd = Task.builder()
.id("my_task")
.topic("blub")
.status("disabled")
.build();
Task toAdd = Task.builder().id("my_task").topic("blub").status("disabled").build();

mockKapacitor.expect(requestTo("/kapacitor/v1/tasks"))
.andExpect(method(HttpMethod.POST))
.andExpect(content().json(
"{" +
"\"id\" : \"my_task\"," +
"\"status\" : \"disabled\"," +
"\"vars\" : { " +
"\"topic\" : {\"type\" : \"string\", \"value\" : \"blub\"} " +
"}" +
"}"
, true))
.andExpect(content().json("{" + "\"id\" : \"my_task\"," + "\"status\" : \"disabled\"," + "\"vars\" : { " + "\"topic\" : {\"type\" : \"string\", \"value\" : \"blub\"} " + "}" + "}", true))
.andRespond(withSuccess(getTestJson("tasks_conflicting_template.json"), MediaType.APPLICATION_JSON));

Task result = controller.addTask(toAdd);
Expand All @@ -228,17 +190,16 @@ class UpdateTasks {

@Test
void changeId() {
Task toAdd = Task.builder()
.id("new_id")
.build();
Task toAdd = Task.builder().id("new_id").build();

mockKapacitor.expect(requestTo("/kapacitor/v1/tasks/my_task"))
.andExpect(method(HttpMethod.PATCH))
.andExpect(content().json(
"{" +
"\"id\" : \"new_id\"" +
"}"
, true))
.andExpect(content().json("{" + "\"id\" : \"new_id\"" + "}", true))
.andRespond(withSuccess(getTestJson("tasks_conflicting_template.json"), MediaType.APPLICATION_JSON));

mockKapacitor.expect(requestTo("/kapacitor/v1/templates/"))
.andExpect(content().json("{}"))
.andExpect(method(HttpMethod.PATCH))
.andRespond(withSuccess(getTestJson("tasks_conflicting_template.json"), MediaType.APPLICATION_JSON));

Task result = controller.updateTask("my_task", toAdd);
Expand All @@ -249,18 +210,16 @@ void changeId() {

@Test
void changeTemplate() {
Task toAdd = Task.builder()
.template("blub")
.build();
Task toAdd = Task.builder().template("blub").build();

mockKapacitor.expect(requestTo("/kapacitor/v1/tasks/my_task"))
.andExpect(method(HttpMethod.PATCH))
.andExpect(content().json(
"{" +
"\"template-id\" : \"blub\"," +
"\"vars\" : { \"inspectit_template_reference\" : {\"type\" : \"string\", \"value\" : \"blub\"} }" +
"}"
, true))
.andExpect(content().json("{" + "\"template-id\" : \"blub\"," + "\"vars\" : { \"inspectit_template_reference\" : {\"type\" : \"string\", \"value\" : \"blub\"} }" + "}", true))
.andRespond(withSuccess(getTestJson("tasks_conflicting_template.json"), MediaType.APPLICATION_JSON));

mockKapacitor.expect(requestTo("/kapacitor/v1/templates/blub"))
.andExpect(content().json("{" + "\"id\" : \"blub\"}"))
.andExpect(method(HttpMethod.PATCH))
.andRespond(withSuccess(getTestJson("tasks_conflicting_template.json"), MediaType.APPLICATION_JSON));

Task result = controller.updateTask("my_task", toAdd);
Expand All @@ -282,14 +241,12 @@ void changeDescriptionAndVariable() {

mockKapacitor.expect(requestTo("/kapacitor/v1/tasks/my_task"))
.andExpect(method(HttpMethod.PATCH))
.andExpect(content().json(
"{" +
"\"vars\" : { " +
"\"inspectit_template_description\" : {\"type\" : \"string\", \"value\" : \"blub\"}, " +
"\"my_dur\" : {\"type\" : \"duration\", \"value\" : 7000000000} " +
"}" +
"}"
, true))
.andExpect(content().json("{" + "\"vars\" : { " + "\"inspectit_template_description\" : {\"type\" : \"string\", \"value\" : \"blub\"}, " + "\"my_dur\" : {\"type\" : \"duration\", \"value\" : 7000000000} " + "}" + "}", true))
.andRespond(withSuccess(getTestJson("tasks_conflicting_template.json"), MediaType.APPLICATION_JSON));

mockKapacitor.expect(requestTo("/kapacitor/v1/templates/"))
.andExpect(content().json("{}"))
.andExpect(method(HttpMethod.PATCH))
.andRespond(withSuccess(getTestJson("tasks_conflicting_template.json"), MediaType.APPLICATION_JSON));

Task result = controller.updateTask("my_task", toAdd);
Expand All @@ -300,21 +257,16 @@ void changeDescriptionAndVariable() {

@Test
void changeTopicAndStatus() {
Task toAdd = Task.builder()
.topic("blub")
.status("disabled")
.build();
Task toAdd = Task.builder().topic("blub").status("disabled").build();

mockKapacitor.expect(requestTo("/kapacitor/v1/tasks/my_task"))
.andExpect(method(HttpMethod.PATCH))
.andExpect(content().json(
"{" +
"\"status\" : \"disabled\"," +
"\"vars\" : { " +
"\"topic\" : {\"type\" : \"string\", \"value\" : \"blub\"} " +
"}" +
"}"
, true))
.andExpect(content().json("{" + "\"status\" : \"disabled\"," + "\"vars\" : { " + "\"topic\" : {\"type\" : \"string\", \"value\" : \"blub\"} " + "}" + "}", true))
.andRespond(withSuccess(getTestJson("tasks_conflicting_template.json"), MediaType.APPLICATION_JSON));

mockKapacitor.expect(requestTo("/kapacitor/v1/templates/"))
.andExpect(content().json("{}"))
.andExpect(method(HttpMethod.PATCH))
.andRespond(withSuccess(getTestJson("tasks_conflicting_template.json"), MediaType.APPLICATION_JSON));

Task result = controller.updateTask("my_task", toAdd);
Expand Down