feat: support classic ingest keys (#180)

## Which problem is this PR solving?

We've released Ingest Keys, but need to update the key detection logic
to allow Ingest Keys to be used to send data to Classic environments.

## Short description of the changes
- updates the Classic API Key detection logic to understand the shape of
a Classic Ingest Key
- updates tests with a more comprehensive list of cases

## How to verify that this has the expected result

It should be possible to use [an ingest
key](https://docs.honeycomb.io/working-with-your-data/settings/api-keys/#ingest-keys-1)
pointed to a classic environment after this change. Please note that the
ability to create ingest keys in classic environments isn't yet publicly
available (since we need to update this library and others to understand
classic ingest keys).

Author: brookesargent

src/honeycomb/opentelemetry/options.py

@@ -1,5 +1,6 @@
 import logging
 import os
+import re
 from opentelemetry.sdk.environment_variables import (
     OTEL_EXPORTER_OTLP_ENDPOINT,
     OTEL_EXPORTER_OTLP_INSECURE,
@@ -92,13 +93,21 @@
 def is_classic(apikey: str) -> bool:
     """
     Determines whether the passed in API key is a classic API key or not.
-    Modern API keys have 22 or 23 characters.
-    Classic API keys have 32 characters.
+    v1 Configuration API keys have 22 or 23 characters.
+    v1 Classic Configuration API keys have 32 characters.
+    v2 Ingest keys have 64 characters and a prefix of hcxik.
+    v2 Classic Ingest keys have 64 characters and a prefix of hcxic.
 
     Returns:
         bool: true if the api key is a classic key, false if not
     """
-    return apikey and len(apikey) == 32
+    if not apikey:
+        return False
+    if re.match(r'^[a-f0-9]{32}$', apikey):
+        return True
+    if re.match(r'^hc[a-z]ic_[a-z0-9]{58}$', apikey):
+        return True
+    return False
 
 
 def parse_bool(environment_variable: str,

tests/test_options.py

@@ -7,7 +7,12 @@
     OTEL_EXPORTER_OTLP_TRACES_ENDPOINT,
     OTEL_SERVICE_NAME,
 )
-from tests.utils import APIKEY
+from tests.utils import (
+    APIKEY,
+    CLASSIC_APIKEY,
+    INGEST_APIKEY,
+    CLASSIC_INGEST_APIKEY,
+)
 from honeycomb.opentelemetry.options import (
     DEBUG,
     DEFAULT_API_ENDPOINT,
@@ -21,6 +26,7 @@
     HONEYCOMB_METRICS_APIKEY,
     HONEYCOMB_METRICS_DATASET,
     HONEYCOMB_TRACES_APIKEY,
+    is_classic,
     SAMPLE_RATE
 )
 
@@ -575,3 +581,18 @@ def test_debug_sets_log_level_to_debug():
 def test_debug_with_custom_log_level_sets_log_level_to_debug():
     options = HoneycombOptions(debug=True, log_level="INFO")
     assert options.log_level == "DEBUG"
+
+def test_empty_key():
+    assert is_classic("") == False
+
+def test_configuration_key():
+    assert is_classic(APIKEY) == False
+
+def test_ingest_key():
+    assert is_classic(INGEST_APIKEY) == False
+
+def test_classic_configuration_key():
+    assert is_classic(CLASSIC_APIKEY) == True
+
+def test_classic_ingest_key():
+    assert is_classic(CLASSIC_INGEST_APIKEY) == True

tests/utils.py

@@ -1,4 +1,7 @@
 # classic keys are 32 chars long
-CLASSIC_APIKEY = "this is a string that is 32 char"
+CLASSIC_APIKEY = "c1a551c1111111111111111111111111"
 # non-classic keys are 22 chars log
-APIKEY = "an api key for 22 char"
+APIKEY = "shinynewenvironmentkey"
+# v2 key format
+CLASSIC_INGEST_APIKEY="hcxic_1234567890123456789012345678901234567890123456789012345678"
+INGEST_APIKEY="hcxik_1234567890123456789012345678901234567890123456789012345678"