Skip to main content
Version: 0.8.x

Frequently Asked Questions

Troubleshooting​

Why are some of Lunar features not functioning correctly?
If you're experiencing issues with Lunar features, it's important to check the Lunar logs for error messages or warnings. These logs can provide valuable insights into what might be causing the problem. One common step to diagnose issues is to adjust the log level.
Here's how you can do it:
     
    1. Go to the Lunar Proxy's Configuration page.
    2. Look for the relevant environment variable: LOG_LEVEL.
    3. Configure the log level as needed. The log level can be set to one of the following values: DEBUG, INFO, WARN, ERROR.

Discover​

Are there any additional configurations required to make the discover command work?
No, there are no additional configurations needed to obtain the metrics recorded during the discovery process. The metrics are presented via printed JSON and written into a local file for your convenience. Nevertheless, you must ensure your Lunar interceptor is working as expected.
The presented JSON is empty, what should I do?
If the presented JSON is empty, it means that no metrics were recorded during the discovery process.
In such cases, you can take the following steps:
  • Ensure that Lunar Interceptor is properly integrated and traffic is being redirected to Lunar Proxy. Refer to the validation section for more information.
  • Check for any error messages or warnings in the Lunar logs that might indicate issues with the remedy plugin's configuration or execution. More information can be found on the Configuration page.
  • If the issue persists, consider reviewing the Lunar documentation or seeking assistance from the Lunar support team to troubleshoot the problem further.
    • Why do I see some old entries in the presented JSON?
    The presence of old entries in the presented JSON could be due to the fact that the Lunar Proxy retains historical data until it is reset. In order to clear the old history from the JSON file, you need to reset the Lunar Proxy.

    Customize​

    How can I customize and activate Lunar plugins?
    The policies.yaml file serves as the central configuration hub for Lunar, allowing users to define policies and customize diagnose, export and remedy plugins. Located in the /etc/lunar-proxy directory, it can easily be updated by running the apply_policies command or by restarting Lunar.
    What happens if no plugins are defined in the policies.yaml file?
    If no plugins are defined, Lunar Proxy will act as a regular API proxy, forwarding requests to the upstream server and returning the corresponding responses.
    Can Lunar plugins be applied globally to all endpoints?
    Yes, Lunar plugins can be defined in the global section of the policies.yaml file to apply them globally to all endpoints.

    Diagnose & Export Plugins​

    Does Lunar provide managed instances of Grafana or Prometheus?
    No, Lunar does not offer managed instances of Grafana or Prometheus at the moment. It is assumed that users already have Grafana and Prometheus set up as a prerequisite for the Prometheus data exporter to work properly
    What should I check if the obfuscation capabilities are not working?
    Review the configuration in the policies.yaml file. Make sure the `obfuscate` parameter is correctly placed under the har_exporter configuration.
    Here's an example:
    diagnosis:
      - name: "Export Obfuscated HAR Logs to S3"
        enabled: true
        config:
          har_exporter:
            transaction_max_size: 5000
            obfuscate:
              enabled: true
        export: s3

    Remedy Plugins​

    How can I identify if Lunar generated a response for a transaction?
    To identify if Lunar generated the response for a certain transaction, you can check for the presence of the x-lunar-generated-response: true header in the response. If this header is included in the response, it indicates that Lunar processed the request and generated the response instead of forwarding it to the original API provider.
    What should I do if a remedy plugin is not working as expected?
    If a remedy plugin is not working as expected, there are a few things you can check:
  • Ensure that the remedy policy for the plugin is properly configured and associated with the relevant endpoints.
  • Ensure that the endpoint URLs in the policies.yaml file follow the correct structure. When defining URL patterns for remedies, consider using wildcards and path parameters appropriately to match the intended API traffic.
  • Verify that the parameter enabled for the remedy plugin is set to true. If it's set to false, the plugin will not be active and will not apply any modifications or actions.
  • Check for any error messages or warnings in the Lunar logs that might indicate issues with the remedy plugin's configuration or execution. More information can be found on the Configuration page.
  • If the issue persists, consider reviewing the Lunar documentation or seeking assistance from the Lunar support team to troubleshoot the problem further.