rakam-registry.json

{"modules":[{"name":"A/B Testing Module","description":"A/B Testing with your event data","className":"org.rakam.analysis.abtesting.ABTestingModule","isActive":true,"condition":{"property":"event.ab-testing.enabled","expectedValue":"true"},"properties":[]},{"name":"Event Explorer Module","description":"It allows analyzing and visualizing events via a simple interface.","className":"org.rakam.analysis.eventexplorer.EventExplorerModule","isActive":true,"condition":{"property":"event-explorer.enabled","expectedValue":"true"},"properties":[]},{"name":"Funnel Analyzer Module","description":"Analyzes event data and creates funnels of user activities.","className":"org.rakam.analysis.funnel.FunnelAnalyzerModule","isActive":true,"condition":{"property":"user.funnel-analysis.enabled","expectedValue":"true"},"properties":[]},{"name":"Rakam real-time module for time-series data","description":"Allows you to create real-time dashboards for your events.","className":"org.rakam.analysis.realtime.RealTimeModule","isActive":true,"condition":{"property":"real-time.enabled","expectedValue":"true"},"properties":[{"property":"real-time.enabled","defaultValue":"false","description":""},{"property":"realtime.window.interval","defaultValue":"5.00s","description":""},{"property":"realtime.window.interval","defaultValue":"75.00s","description":""}]},{"name":"Retention Analyzer Module","description":"Analyzes events of each user and allows you to improve your user acquisition and retention activities.","className":"org.rakam.analysis.retention.RetentionAnalyzerModule","isActive":true,"condition":{"property":"user.retention-analysis.enabled","expectedValue":"true"},"properties":[]},{"name":"Event stream module","description":"Subscribes event stream and notifies new events in real-time","className":"org.rakam.analysis.stream.EventStreamModule","isActive":true,"condition":{"property":"event.stream.enabled","expectedValue":"true"},"properties":[]},{"name":"Automation Module","description":"Take action based on events","className":"org.rakam.automation.AutomationModule","isActive":true,"condition":{"property":"automation.enabled","expectedValue":"true"},"properties":[{"property":"secret-key","defaultValue":"tpnf0affbb5o82mgqcq99gmi67ve6irh8sjn41dkqrs454fbbgfkpr4tbr0hapkpch21b2","description":"The secret key that will be used when encrypting sessions and passwords. Do not expose this key because if it's known, the sessions may be hijacked. If you don't set a secret key, it will be generated randomly for every restart."}]},{"name":"Customer Analytics Module","description":"Analyze your users","className":"org.rakam.plugin.user.UserModule","isActive":true,"condition":{"property":"plugin.user.enabled","expectedValue":"true"},"properties":[{"property":"event.ab-testing.enabled","defaultValue":"false","description":""},{"property":"plugin.user.actions","defaultValue":"null","description":""},{"property":"automation.enabled","defaultValue":"false","description":""},{"property":"plugin.user.enable-user-mapping","defaultValue":"false","description":""},{"property":"user.funnel-analysis.enabled","defaultValue":"true","description":""},{"property":"plugin.user.storage.hide-columns","defaultValue":"null","description":""},{"property":"plugin.user.storage.identifier-column","defaultValue":"null","description":""},{"property":"plugin.user.mailbox.persistence","defaultValue":"null","description":""},{"property":"plugin.user.mailbox.enable","defaultValue":"false","description":""},{"property":"user.retention-analysis.enabled","defaultValue":"true","description":""},{"property":"user.storage.session-column","defaultValue":"null","description":""},{"property":"plugin.user.storage","defaultValue":"null","description":""}]},{"name":"Recipe module","description":null,"className":"org.rakam.recipe.RecipeModule","isActive":true,"condition":null,"properties":[{"property":"recipes","defaultValue":"null","description":""}]},{"name":"Kafka Event Collector","description":"Sends events to Apache Kafka","className":"org.rakam.kafka.collection.KafkaCollectorModule","isActive":true,"condition":{"property":"event.store","expectedValue":"kafka"},"properties":[{"property":"event.store.kafka.commit-interval","defaultValue":"5.00s","description":""},{"property":"event.store.kafka.buffer-size","defaultValue":"64kB","description":""},{"property":"event.store.kafka.connect-timeout","defaultValue":"10.00s","description":""},{"property":"event.store.kafka.nodes","defaultValue":"[]","description":""},{"property":"event.store.kafka.zookeeper.connect","defaultValue":"null","description":""}]},{"name":"ClickHouse backend for Rakam","description":"Rakam backend for big-data.","className":"org.rakam.clickhouse.ClickHouseModule","isActive":true,"condition":{"property":"store.adapter","expectedValue":"clickhouse"},"properties":[{"property":"clickhouse.address","defaultValue":"http://127.0.0.1:8123","description":""},{"property":"clickhouse.cold-storage-prefix","defaultValue":"null","description":""},{"property":"clickhouse.hot-storage-prefix","defaultValue":"null","description":""},{"property":"event.schema.enable-dynamic","defaultValue":"true","description":""},{"property":"event.store","defaultValue":"null","description":""},{"property":"event.schema.store","defaultValue":"null","description":""},{"property":"report.metadata.store","defaultValue":"null","description":""},{"property":"event-explorer.enabled","defaultValue":"false","description":""}]},{"name":"Dynamodb Api Key Service","description":null,"className":"org.rakam.aws.dynamodb.apikey.DynamodbApiKeyModule","isActive":true,"condition":{"property":"api-key-service.adapter","expectedValue":"dynamodb"},"properties":[{"property":"aws.access-key","defaultValue":"null","description":""},{"property":"aws.dynamodb-endpoint","defaultValue":"null","description":""},{"property":"event.store.bulk.s3-bucket","defaultValue":"null","description":""},{"property":"event.store.kinesis.stream","defaultValue":"null","description":""},{"property":"aws.kinesis-endpoint","defaultValue":"null","description":""},{"property":"aws.lambda-endpoint","defaultValue":"null","description":""},{"property":"aws.region","defaultValue":"null","description":""},{"property":"aws.s3-endpoint","defaultValue":"null","description":""},{"property":"aws.secret-access-key","defaultValue":"null","description":""},{"property":"api-key-service.adapter.dynamodb.table","defaultValue":"null","description":""}]},{"name":"Dynamodb Config Manager","description":null,"className":"org.rakam.aws.dynamodb.config.DynamodbConfigManagerModule","isActive":true,"condition":{"property":"config-manager.adapter","expectedValue":"dynamodb"},"properties":[{"property":"aws.access-key","defaultValue":"null","description":""},{"property":"aws.dynamodb-endpoint","defaultValue":"null","description":""},{"property":"event.store.bulk.s3-bucket","defaultValue":"null","description":""},{"property":"event.store.kinesis.stream","defaultValue":"null","description":""},{"property":"aws.kinesis-endpoint","defaultValue":"null","description":""},{"property":"aws.lambda-endpoint","defaultValue":"null","description":""},{"property":"aws.region","defaultValue":"null","description":""},{"property":"aws.s3-endpoint","defaultValue":"null","description":""},{"property":"aws.secret-access-key","defaultValue":"null","description":""},{"property":"config-manager.adapter.dynamodb.table","defaultValue":"null","description":""}]},{"name":null,"description":null,"className":"org.rakam.aws.dynamodb.metastore.DynamodbMetastoreModule","isActive":true,"condition":{"property":"metastore.adapter","expectedValue":"dynamodb"},"properties":[{"property":"aws.access-key","defaultValue":"null","description":""},{"property":"aws.dynamodb-endpoint","defaultValue":"null","description":""},{"property":"event.store.bulk.s3-bucket","defaultValue":"null","description":""},{"property":"event.store.kinesis.stream","defaultValue":"null","description":""},{"property":"aws.kinesis-endpoint","defaultValue":"null","description":""},{"property":"aws.lambda-endpoint","defaultValue":"null","description":""},{"property":"aws.region","defaultValue":"null","description":""},{"property":"aws.s3-endpoint","defaultValue":"null","description":""},{"property":"aws.secret-access-key","defaultValue":"null","description":""},{"property":"metastore.adapter.dynamodb.table","defaultValue":"metastore","description":""}]},{"name":null,"description":null,"className":"org.rakam.aws.dynamodb.metastore.DynamodbQueryMetastoreModule","isActive":true,"condition":{"property":"query-metadata-store.adapter","expectedValue":"dynamodb"},"properties":[{"property":"aws.access-key","defaultValue":"null","description":""},{"property":"aws.dynamodb-endpoint","defaultValue":"null","description":""},{"property":"event.store.bulk.s3-bucket","defaultValue":"null","description":""},{"property":"event.store.kinesis.stream","defaultValue":"null","description":""},{"property":"aws.kinesis-endpoint","defaultValue":"null","description":""},{"property":"aws.lambda-endpoint","defaultValue":"null","description":""},{"property":"aws.region","defaultValue":"null","description":""},{"property":"aws.s3-endpoint","defaultValue":"null","description":""},{"property":"aws.secret-access-key","defaultValue":"null","description":""},{"property":"query-metadata-store.adapter.dynamodb.table","defaultValue":"null","description":""}]},{"name":"Dynamodb backend for user storage","description":"Dynamodb user storage backend for basic CRUD and search operations.","className":"org.rakam.aws.dynamodb.user.DynamodbUserStorageModule","isActive":true,"condition":{"property":"plugin.user.storage","expectedValue":"dynamodb"},"properties":[{"property":"plugin.user.storage.dynamodb.table","defaultValue":"null","description":""}]},{"name":"AWS Kinesis event store module","description":"Puts your events directly to AWS Kinesis streams.","className":"org.rakam.aws.kinesis.AWSKinesisModule","isActive":true,"condition":{"property":"event.store","expectedValue":"kinesis"},"properties":[{"property":"aws.access-key","defaultValue":"null","description":""},{"property":"aws.dynamodb-endpoint","defaultValue":"null","description":""},{"property":"event.store.bulk.s3-bucket","defaultValue":"null","description":""},{"property":"event.store.kinesis.stream","defaultValue":"null","description":""},{"property":"aws.kinesis-endpoint","defaultValue":"null","description":""},{"property":"aws.lambda-endpoint","defaultValue":"null","description":""},{"property":"aws.region","defaultValue":"null","description":""},{"property":"aws.s3-endpoint","defaultValue":"null","description":""},{"property":"aws.secret-access-key","defaultValue":"null","description":""},{"property":"presto.streaming.port","defaultValue":"0","description":""}]},{"name":null,"description":null,"className":"org.rakam.aws.lambda.AWSLambdaModule","isActive":true,"condition":{"property":"tasks.enable","expectedValue":"true"},"properties":[{"property":"task.market_s3_bucket","defaultValue":"rakam-task-market","description":""}]},{"name":"Web Interface for Rakam APIs","description":"Can be used as a BI tool and a tool that allows you to create your customized analytics service frontend.","className":"org.rakam.ui.RakamUIModule","isActive":true,"condition":{"property":"ui.enable","expectedValue":"true"},"properties":[{"property":"secret-key","defaultValue":"lsbmml509md16uk16kvp1ikr34n6lu1aavohvab975jtvmctc6as2t878r6mb01m45ho0j","description":"The secret key that will be used when encrypting sessions and passwords. Do not expose this key because if it's known, the sessions may be hijacked. If you don't set a secret key, it will be generated randomly for every restart."},{"property":"ui.custom-page.backend","defaultValue":"null","description":""},{"property":"ui.custom-page.backend.directory","defaultValue":"null","description":""},{"property":"ui.enable","defaultValue":"true","description":""},{"property":"ui.google-login-client-id","defaultValue":"null","description":""},{"property":"ui.hash-password","defaultValue":"false","description":"Set true if you want passwords to be hashed with ui.secret-key before encrypting with one-way hashing algorithm. If you modify this key, all passwords saved in database will be invalidated."},{"property":"stripe.key","defaultValue":"null","description":""},{"property":"ui.directory","defaultValue":"null","description":""}]},{"name":"Fallback for Rakam API BI Module","description":null,"className":"org.rakam.ui.RakamWebUIFallbackModule","isActive":true,"condition":null,"properties":[]},{"name":"PrestoDB backend for Rakam","description":"Rakam backend for high-throughput systems.","className":"org.rakam.presto.PrestoModule","isActive":true,"condition":{"property":"store.adapter","expectedValue":"presto"},"properties":[{"property":"event.schema.enable-dynamic","defaultValue":"true","description":""},{"property":"event.store","defaultValue":"null","description":""},{"property":"event.schema.store","defaultValue":"null","description":""},{"property":"report.metadata.store","defaultValue":"null","description":""},{"property":"event.stream.enabled","defaultValue":"true","description":""},{"property":"presto.address","defaultValue":"null","description":""},{"property":"presto.bulk-connector","defaultValue":"middleware","description":""},{"property":"presto.cold-storage-connector","defaultValue":"null","description":""},{"property":"presto.hot-storage-connector","defaultValue":"null","description":""},{"property":"presto.streaming-connector","defaultValue":"streaming","description":""},{"property":"presto.user-connector","defaultValue":"user","description":""}]},{"name":"GeoIP Event Mapper","description":"It attaches the events that have ip attribute with location information by GeoIP lookup service.","className":"org.rakam.collection.mapper.geoip.maxmind.MaxmindGeoIPModule","isActive":true,"condition":{"property":"plugin.geoip.enabled","expectedValue":"true"},"properties":[{"property":"plugin.geoip.attributes","defaultValue":"null","description":"The list of attributes that will be attached to event. Available attributes: country, country_code, region,city, latitude, longitude, timezone"},{"property":"plugin.geoip.connection-type-database.url","defaultValue":"null","description":""},{"property":"plugin.geoip.database.url","defaultValue":"http://geolite.maxmind.com/download/geoip/database/GeoLite2-City.mmdb.gz","description":""},{"property":"plugin.geoip.isp-database.url","defaultValue":"null","description":""},{"property":"plugin.geoip.use-existing-fields","defaultValue":"false","description":""}]},{"name":"GeoIP Event Mapper","description":"It attaches the events that have ip attribute with location information by GeoIP lookup service.","className":"org.rakam.collection.mapper.geoip.maxmind.ip2location.IP2LocationGeoIPModule","isActive":true,"condition":{"property":"plugin.geoip.ip2location","expectedValue":"true"},"properties":[{"property":"plugin.geoip.database.url","defaultValue":"null","description":""},{"property":"plugin.geoip.database.dbid","defaultValue":"3","description":""}]},{"name":"Postgresql Module","description":"Postgresql deployment type module","className":"org.rakam.postgresql.PostgresqlModule","isActive":true,"condition":{"property":"store.adapter","expectedValue":"postgresql"},"properties":[{"property":"store.adapter.postgresql.connection.max-idle-timeout","defaultValue":"null","description":""},{"property":"store.adapter.postgresql.connection.max-life-time","defaultValue":"null","description":""},{"property":"store.adapter.postgresql.data-source","defaultValue":"null","description":""},{"property":"store.adapter.postgresql.max-connection","defaultValue":"null","description":""},{"property":"store.adapter.postgresql.password","defaultValue":"","description":""},{"property":"store.adapter.postgresql.table","defaultValue":"null","description":""},{"property":"store.adapter.postgresql.url","defaultValue":"null","description":""},{"property":"store.adapter.postgresql.username","defaultValue":"null","description":""}]},{"name":"Postgresql backend for user storage","description":"Postgresql user storage backend for basic CRUD and search operations.","className":"org.rakam.postgresql.plugin.user.PostgresqlUserModule","isActive":true,"condition":{"property":"plugin.user.storage","expectedValue":"postgresql"},"properties":[{"property":"store.adapter.postgresql.connection.max-idle-timeout","defaultValue":"null","description":""},{"property":"store.adapter.postgresql.connection.max-life-time","defaultValue":"null","description":""},{"property":"store.adapter.postgresql.data-source","defaultValue":"null","description":""},{"property":"store.adapter.postgresql.max-connection","defaultValue":"null","description":""},{"property":"store.adapter.postgresql.password","defaultValue":"","description":""},{"property":"store.adapter.postgresql.table","defaultValue":"null","description":""},{"property":"store.adapter.postgresql.url","defaultValue":"null","description":""},{"property":"store.adapter.postgresql.username","defaultValue":"null","description":""}]},{"name":"Event website related attribute mapping module","description":"Resolves _referrer, _user_agent attributes and related fields such as user_agent_version, referrer_medium to the event.","className":"org.rakam.module.website.WebsiteEventMapperModule","isActive":true,"condition":{"property":"module.website.mapper","expectedValue":"true"},"properties":[{"property":"module.website.mapper.referrer","defaultValue":"true","description":""},{"property":"module.website.mapper.user_agent.track_spiders","defaultValue":"false","description":""},{"property":"module.website.mapper.user-agent","defaultValue":"true","description":""}]},{"name":"JDBC report metadata store","description":"Stores report metadata (materialized, continuous queries) in RDBMS databases","className":"org.rakam.analysis.metadata.JDBCReportMetastoreModule","isActive":true,"condition":{"property":"report.metadata.store","expectedValue":"jdbc"},"properties":[{"property":"report.metadata.store.jdbc.connection.max-idle-timeout","defaultValue":"null","description":""},{"property":"report.metadata.store.jdbc.connection.max-life-time","defaultValue":"null","description":""},{"property":"report.metadata.store.jdbc.data-source","defaultValue":"null","description":""},{"property":"report.metadata.store.jdbc.max-connection","defaultValue":"null","description":""},{"property":"report.metadata.store.jdbc.password","defaultValue":"","description":""},{"property":"report.metadata.store.jdbc.table","defaultValue":"null","description":""},{"property":"report.metadata.store.jdbc.url","defaultValue":"null","description":""},{"property":"report.metadata.store.jdbc.username","defaultValue":"null","description":""}]}]}