Add CommandListener interface for monitoring Redis command operations

[senocak]

Since redis-om uses Jedis behind the scenes, there are 2 open pull requests on Jedis repository for a long time to implement listener, I do not think it will be merged very soon. So, implemeted basic listener in each redisearch functionallity to listen the operations

• Add redis command listener jedis#1791
• Redis command listener jedis#1972

Using in client side is very staight forward;

@Component
public class LoggingCommandListener implements CommandListener {
    private static final Logger log = LoggerFactory.getLogger(LoggingUnifiedJedis.class);

    @Override
    public void searchStarted(String indexName, Query q, FTSearchParams params) {
        try {
            final Field field = q.getClass().getDeclaredField("_queryString");
            field.setAccessible(true);
            String queryString = (String) field.get(q);
            log.info("Command Started: FT.SEARCH '{}' '{}'", indexName, queryString);
        } catch (NoSuchFieldException | IllegalAccessException e) {
            log.error("Command started on index: {} (unable to retrieve query string)", indexName);
        }
    }

    @Override
    public void searchFinished(String indexName, Query q, FTSearchParams params, SearchResult searchResult) {
        try {
            final Field field = q.getClass().getDeclaredField("_queryString");
            field.setAccessible(true);
            String queryString = (String) field.get(q);
            log.info("Command Finished: FT.SEARCH '{}' '{}' - Total result: {} ", indexName, queryString, searchResult.getTotalResults());
        } catch (NoSuchFieldException | IllegalAccessException e) {
            log.error("Command started on index: {} (unable to retrieve query string)", indexName);
        }
    }
}

[jit-ci]

Hi, I’m Jit, a friendly security platform designed to help developers build secure applications from day zero with an MVS (Minimal viable security) mindset.

In case there are security findings, they will be communicated to you as a comment inside the PR.

Hope you’ll enjoy using Jit.

Questions? Comments? Want to learn more? Get in touch with us.

[senocak]

@foogaro Kindly reminder please!