This repo contains modules used for handling various configurations of an OpenTSDB observability system including alerts, dashboards, namespaces, users, etc.

tie it all together.

Please follow the IntelliJ Idea setup procedure.

Step by step guide and setup for Eclipse are available here.

• Update local db schema:

./gradlew local-db update

• Upgrade Liquibase

  Ref: Liquibase doc

1. Make sure all of your Liquibase managed databases are up to date by running gradle update on them before upgrading to the new version of the Liquibase plugin.
2. Create a new, throw away database to test your Liquibase change sets. Run gradle update on the new database using the latest version of the Liquibase plugin. This is important because of the deprecated items in the Groovy DSL, and because there are some subtle differences in the ways the different Liquibase versions generate SQL. For example, adding a default value to a boolean column in MySql using defaultValue: "0" worked fine in Liquibase 2, but in Liquibase 3, it generates SQL that doesn't work for MySql - defaultValueNumeric: 0 needs to be used instead.
3. Once you are sure all of your change sets work with the latest Liquibase plugin, clear all checksums that were calculated by the old version of Liquibase 2 by running gradle clearChecksums against all databases.
4. Finally, run gradle changeLogSync on all databases to calculate new checksums.

• Upgrade Local Liquibase

./gradlew local-db clearChecksums
./gradlew local-db changeLogSync

• Run unit tests:

./gradlew test

• Run integration tests:

./gradlew integrationTest -Penv=dev

Follow these steps:

1. Create certificates Run the following command from the project root. It creates a java keystore file (javakeystore.jks) with the self signed certificates in it.

scripts/create_dev_certificates.sh

2. Add the following entry to the host file (/etc/hosts)

127.0.0.1	dev-config.horizon.com

4. Swagger Configuration Download Swagger UI. Extract the zip file and copy the dist directory to your user home directory. You can find the file index.html under dist. Modify the url link from https://petstore.swagger.io/v2/swagger.json to https://dev-config.horizon.com:4443/api/swagger.json in index.html Rename the directory dist to swagger

5. Start server

./gradlew run --args 'dev'

6. Start server in debug mode

./gradlew run --args 'dev' --debug-jvm

7. Connect to remote db machine through ssh tunnel

ssh -L 3306:127.0.0.1:3306 {db_host_name}

You should be able access the Swagger page

1. Docker run

docker run --name configapi -p 8080:8080 IMAGE_ID

or
 
docker run -dit --rm -e JAVA_OPTS=-Dlog4j.configurationFile=/opt/opentsdb/horizon/configapi/log4j2/log4j2.xml -e LOG_DIR=/opt/opentsdb/horizon/configapi/shared-data/logs --mount type=bind,source="$(pwd)",target=/opt/opentsdb/horizon/configapi/shared-data --name configapi -p 8080:8080 {IMAGE_ID} -c=file:///opt/opentsdb/horizon/configapi/shared-data/config.yaml

2. SSH into docker container:

docker exec -it configapi /bin/sh

To use a custom authentication filter, you will have to provide an implementation of javax.servlet.Filter and configure the fully qualified class name as shown below. You can provide the filter init parameters as key and value pair. After successful authentication, the filter should set java.security.Principal in the HttpServletRequest.

import javax.servlet.*;
import javax.servlet.http.*;
import java.io.IOException;
import java.security.Principal;

public class CustomAuthFilter implements Filter {
  @Override
  public void init(FilterConfig filterConfig) throws ServletException {
    // initialize the filter
  }
    
  @Override
  public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
    final HttpServletRequest httpServletRequest = (HttpServletRequest) request;
    final HttpServletResponse httpServletResponse = (HttpServletResponse) response;
    Cookie cookie = readCookie(httpServletRequest);
    if (null == cookie) {
      httpServletResponse.sendError(HttpServletResponse.SC_UNAUTHORIZED, "auth cookie not found");
    } else {
      Principal principal = authenticate(cookie.getValue());
      if (principal == null) {
        httpServletResponse.sendError(
        HttpServletResponse.SC_UNAUTHORIZED, "authentication failure");
      } else {
        HttpServletRequestWrapper requestWrapper =
          new HttpServletRequestWrapper(httpServletRequest) {
            @Override
            public Principal getUserPrincipal() {
              return principal;
            }
        };
        chain.doFilter(requestWrapper, response);
      }
    }
  }
}

serverConfig:
  port: 8080
  ...
  authConfig:
    authFilterClassName: {FQCN of CustomAuthFilter}
    initParams:
          {key1}: {value1}
          {key2}: {value2}

It's not a good idea to mention the secrets for example the database user password in the free text format in the configuration file. It's recommended to store the secrets in an external key store and use the key name in the configuration file. You need to provide an implementation of net.opentsdb.horizon.secrets.KeyReader for the application to read the secrets from the key store. You would also have to provide and implementation of cnet.opentsdb.horizon.secrets.KeyReaderFactory and configure it as shown below.

public class CustomKeyReader extends KeyReader {

  @Override
  protected byte[] readSecret(final String key) {
    // read the secret from the key store and return.
  }
}

public class CustomKeyReaderFactory implements KeyReaderFactory<CustomKeyReader> {
  @Override
  public CustomKeyReader createKeyReader(Map<String, Object> initParams) {
    // instantiate the CustomKeyReader and return
  }
}

Configure the key read factory in the applicationConfig section as shown here.

applicationConfig:
  keyReaderFactoryClassName: {FQCN of CustomKeyReaderFactory}
  initParams:
    initParams:
          {key1}: {value1}
          {key2}: {value2}

Please see the Contributing file for information on how to get involved. We welcome issues, questions, and pull requests.

• Smruti Ranjan Sahoo

This project is licensed under the terms of the Apache 2.0 open source license. Please refer to LICENSE for the full terms.