Configuration Best Practices
The following are the best practices that we recommend when you are configuring
CA Live API Creator.
We recommend the following best practices when you are configuring
CA Live API Creator:
- Consider configuringCA Live API Creatorto run as a cluster of nodes:
For more information about how to configureCA Live API Creatorto run as a cluster, see Configure to Run as a Cluster.
- To provide high availability of services.
- To support failover if there are hardware failures.
- If you expectCA Live API Creatorto handle large numbers of incoming requests.
- When configuring Hazelcast for cluster synchronization strategy, if reliability is more important than performance or if you are configuringCA Live API Creatorto run in an unstable cluster or in a cluster that changes in size frequently, add theLAC_CLUSTER_SYNC_STRATEGYoption when you start API Server with thein_memory_with_lockingproperty value.For more information about this option, see Configure to Run as a Cluster.
Memory & Heap Size Configuration
Repository & Backup Configurations
If your server is for development, disable backups in runtime mode where you have APIs deployed to these environments as part of your CI/CD process. Disable backups by adding the
LAC_REPOSITORY_BACKUPoption when you start API Server and set the value to
- Persist yourCA Live API Creatorlog messages by creating a logger for externalizing your API logs, listener logs, and timer logs.For more information about how to configure external logging, see External Logging.
- Set up log levels that are appropriate for your environments.For more information about how to configure logging levels, see View Logging Information.
- If you have configuredCA Live API Creatorto collect and send telemetry data, or usage data, configure thelactelemetryloggerlogger to capture the activities for sending usage data.For more information about how to configure this logger, see External Logging.
- In production environments, minimize in-memory usage and optimize your server performance by completing the following:
- Turn off in-memory logging at the API Server level by adding theLAC_USE_IN_MEMORY_LOGGINGoption when you start API Server and setting it tofalse. By default,CA Live API Creatordetermines whether to display the in-memory logs based on the API level setting for displaying in-memory logs (theEnable In-Memory Logscheckbox on the Settings tab) (the value for this option istrue).
- Configure external logging.
Determine whether you require a database for persisting your authentication tokens.
For more information, see Create a Database for your Authentication Tokens.
For a list of all best practices, see Best Practices.