ES Plugin to log rest requests

saikettewary · January 3, 2019, 3:51pm

Hi,
I have a plugin that logs all rest requests . Currently this is implemented using getRestHandlerWrapper with my plugins RestHandler.

What is other way i can achieve the same without using getRestHandlerWrapper as i understand only one plugin in the cluster can implement this.

Thanks
Saiket

saikettewary · January 4, 2019, 4:26pm

Hi @s1monw sorry for tagging you directly here .. but i was hoping if you have a quick note on this.

s1monw · January 5, 2019, 9:26am

only one plugin per node can implement this, not per cluster. There is no other way to implement this right now.

saikettewary · January 7, 2019, 4:01pm

Thanks for the response @s1monw , I truly appreciate it. Do you know if this will/might change in future releases?

Also i came across this test Case in elastic codebase -

github.com

elastic/elasticsearch/blob/543e8b8b57b321f0c89f3cdfac14de0d57c1fdcd/modules/reindex/src/test/java/org/elasticsearch/index/reindex/ReindexFromRemoteWithAuthTests.java#L131


public void testReindexWithBadAuthentication() throws Exception {
    ReindexRequestBuilder request = ReindexAction.INSTANCE.newRequestBuilder(client()).source("source").destination("dest")
            .setRemoteInfo(newRemoteInfo("junk", "auth", emptyMap()));
    ElasticsearchStatusException e = expectThrows(ElasticsearchStatusException.class, () -> request.get());
    assertThat(e.getMessage(), containsString("\"reason\":\"Bad Authorization\""));
}


/**
 * Plugin that demands authentication.
 */
public static class TestPlugin extends Plugin implements ActionPlugin {
    @Override
    public List<Class<? extends ActionFilter>> getActionFilters() {
        return singletonList(ReindexFromRemoteWithAuthTests.TestFilter.class);
    }


    @Override
    public Collection<String> getRestHeaders() {
        return Arrays.asList(TestFilter.AUTHORIZATION_HEADER, TestFilter.EXAMPLE_HEADER);
    }
}

Where the comment says "Action filter that will reject the request if it isn't authenticated." and when i look at void apply method inside TestFilter , its doing
chain.proceed(task, action, request, listener);

How is this different? Isn't it also pre-processing the rest requests for authentication?

rjernst · January 9, 2019, 1:11am

The chain you see there is for transport actions. This is an older way of extending, which rest actions used to also do. However, the chaining was complicated and error prone. Transport actions will eventually be moved to a singular wrapper as well. It is unlikely this will be relaxed in the future, as the complexity of supporting multiple was too cumbersome to maintain.

saikettewary · January 9, 2019, 3:36pm

Thanks for the information. It is helpful.

system · February 6, 2019, 3:36pm

This topic was automatically closed 28 days after the last reply. New replies are no longer allowed.

Topic		Replies	Views
RestFilters for ES 5.x Elasticsearch	13	1345	July 20, 2018
Help writing a custom plugin to allow only GET requests Elasticsearch	1	328	June 23, 2020
Overriding an installed ActionPlugin that implements getRestHandlerWrapper() Elasticsearch	1	496	July 2, 2020
Authentication Plugin Elasticsearch	3	546	November 7, 2018
Plugin for request logging Elasticsearch	3	375	July 6, 2017

ES Plugin to log rest requests

Related topics