spanport 0.1.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- spanport/__init__.py +100 -0
- spanport/_constants.py +19 -0
- spanport/_key_check.py +63 -0
- spanport/_pipeline.py +58 -0
- spanport/_sdk_logger.py +21 -0
- spanport-0.1.0.dist-info/METADATA +65 -0
- spanport-0.1.0.dist-info/RECORD +9 -0
- spanport-0.1.0.dist-info/WHEEL +4 -0
- spanport-0.1.0.dist-info/licenses/LICENSE +201 -0
spanport/__init__.py
ADDED
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
"""Spanport SDK: send your app's existing Python logs to Spanport.
|
|
2
|
+
|
|
3
|
+
import spanport
|
|
4
|
+
spanport.init(data_key="sp_ingest_...", service="hr-portal-api")
|
|
5
|
+
|
|
6
|
+
The SDK never breaks the host app: init() never raises, logs are sent in the background, and if
|
|
7
|
+
anything is wrong it says so on stderr and the app carries on.
|
|
8
|
+
"""
|
|
9
|
+
|
|
10
|
+
import logging
|
|
11
|
+
import threading
|
|
12
|
+
|
|
13
|
+
from opentelemetry.instrumentation.logging.handler import LoggingHandler
|
|
14
|
+
from opentelemetry.sdk._logs import LoggerProvider
|
|
15
|
+
|
|
16
|
+
from spanport._constants import (
|
|
17
|
+
DATA_KEY_PREFIX,
|
|
18
|
+
DEFAULT_COLLECTOR_URL,
|
|
19
|
+
DEFAULT_SERVER_URL,
|
|
20
|
+
KEY_CHECK_THREAD_NAME,
|
|
21
|
+
)
|
|
22
|
+
from spanport._key_check import check_data_key
|
|
23
|
+
from spanport._pipeline import build_logging_handler, build_otlp_exporter
|
|
24
|
+
from spanport._sdk_logger import get_sdk_logger
|
|
25
|
+
|
|
26
|
+
__all__ = ["init", "shutdown"]
|
|
27
|
+
|
|
28
|
+
# The active pipeline, kept so shutdown() can flush and detach it.
|
|
29
|
+
_active_handler: LoggingHandler | None = None
|
|
30
|
+
_active_provider: LoggerProvider | None = None
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
def init(
|
|
34
|
+
data_key: str,
|
|
35
|
+
service: str,
|
|
36
|
+
collector_url: str = DEFAULT_COLLECTOR_URL,
|
|
37
|
+
server_url: str = DEFAULT_SERVER_URL,
|
|
38
|
+
check_key: bool = True,
|
|
39
|
+
) -> None:
|
|
40
|
+
"""Start sending this app's logs to Spanport. Never raises.
|
|
41
|
+
|
|
42
|
+
Hooks the root logger, so every existing `logging` call is sent; the app's own log level
|
|
43
|
+
still decides which records are written. Call once at start-up.
|
|
44
|
+
|
|
45
|
+
Args:
|
|
46
|
+
data_key: The project's data key (sp_ingest_...).
|
|
47
|
+
service: Name of this app as shown in Spanport, e.g. "hr-portal-api".
|
|
48
|
+
collector_url: Where logs are sent: the Spanport OTel Collector (OTLP/HTTP).
|
|
49
|
+
server_url: The Spanport server, asked once whether the data key is valid.
|
|
50
|
+
check_key: Set False to skip the start-up key check (e.g. no route to the server).
|
|
51
|
+
"""
|
|
52
|
+
try:
|
|
53
|
+
_start(data_key, service, collector_url, server_url, check_key)
|
|
54
|
+
except Exception:
|
|
55
|
+
# The host app must keep running whatever goes wrong here.
|
|
56
|
+
get_sdk_logger().exception("setup failed; the app keeps running but logs are not sent")
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
def shutdown() -> None:
|
|
60
|
+
"""Send any logs still queued and stop. Safe to call more than once. Never raises."""
|
|
61
|
+
global _active_handler, _active_provider
|
|
62
|
+
try:
|
|
63
|
+
if _active_handler is not None:
|
|
64
|
+
logging.getLogger().removeHandler(_active_handler)
|
|
65
|
+
if _active_provider is not None:
|
|
66
|
+
_active_provider.shutdown()
|
|
67
|
+
except Exception:
|
|
68
|
+
get_sdk_logger().exception("shutdown failed; some queued logs may not have been sent")
|
|
69
|
+
finally:
|
|
70
|
+
_active_handler = None
|
|
71
|
+
_active_provider = None
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
def _start(
|
|
75
|
+
data_key: str, service: str, collector_url: str, server_url: str, check_key: bool
|
|
76
|
+
) -> None:
|
|
77
|
+
"""Validate the arguments, attach the logging pipeline and start the key check."""
|
|
78
|
+
global _active_handler, _active_provider
|
|
79
|
+
sdk_logger = get_sdk_logger()
|
|
80
|
+
if _active_handler is not None:
|
|
81
|
+
sdk_logger.warning("init() was already called; ignoring the second call")
|
|
82
|
+
return
|
|
83
|
+
if not data_key.startswith(DATA_KEY_PREFIX):
|
|
84
|
+
sdk_logger.error("data_key must be a data key (%s...); logs are not sent", DATA_KEY_PREFIX)
|
|
85
|
+
return
|
|
86
|
+
if not service:
|
|
87
|
+
sdk_logger.error("service must name this app, e.g. service='hr-portal-api'; logs not sent")
|
|
88
|
+
return
|
|
89
|
+
exporter = build_otlp_exporter(collector_url, data_key)
|
|
90
|
+
_active_handler, _active_provider = build_logging_handler(service, exporter)
|
|
91
|
+
logging.getLogger().addHandler(_active_handler)
|
|
92
|
+
sdk_logger.info("sending logs for service %s to %s", service, collector_url)
|
|
93
|
+
if check_key:
|
|
94
|
+
# In the background, so a slow or unreachable server never delays the app's start-up.
|
|
95
|
+
threading.Thread(
|
|
96
|
+
target=check_data_key,
|
|
97
|
+
args=(server_url, data_key),
|
|
98
|
+
name=KEY_CHECK_THREAD_NAME,
|
|
99
|
+
daemon=True,
|
|
100
|
+
).start()
|
spanport/_constants.py
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
"""SDK constants. Code refers to these by name, never by inline value."""
|
|
2
|
+
|
|
3
|
+
DATA_KEY_PREFIX = "sp_ingest_"
|
|
4
|
+
DEFAULT_COLLECTOR_URL = "http://localhost:4318"
|
|
5
|
+
DEFAULT_SERVER_URL = "http://localhost:8000"
|
|
6
|
+
OTLP_LOGS_PATH = "/v1/logs"
|
|
7
|
+
CURRENT_API_KEY_PATH = "/api/v1/api-keys/current"
|
|
8
|
+
AUTHORIZATION_HEADER = "Authorization"
|
|
9
|
+
BEARER_PREFIX = "Bearer "
|
|
10
|
+
ALLOWED_URL_SCHEMES = ("http", "https")
|
|
11
|
+
KEY_CHECK_TIMEOUT_SECONDS = 5
|
|
12
|
+
KEY_CHECK_THREAD_NAME = "spanport-key-check"
|
|
13
|
+
VISIBLE_KEY_SUFFIX_LENGTH = 4
|
|
14
|
+
|
|
15
|
+
# The SDK's own messages go to stderr through this logger and are never exported.
|
|
16
|
+
SDK_LOGGER_NAME = "spanport"
|
|
17
|
+
SDK_LOG_FORMAT = "%(levelname)s spanport: %(message)s"
|
|
18
|
+
# Loggers on the export path. Exporting their records would send logs about sending logs.
|
|
19
|
+
EXPORT_PATH_LOGGER_PREFIXES = ("spanport", "opentelemetry", "urllib3", "requests")
|
spanport/_key_check.py
ADDED
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
"""Checks the data key once against the Spanport server and says clearly if it is wrong.
|
|
2
|
+
|
|
3
|
+
The collector accepts logs without checking keys, so without this an app with a wrong key would
|
|
4
|
+
lose its logs silently.
|
|
5
|
+
"""
|
|
6
|
+
|
|
7
|
+
import urllib.error
|
|
8
|
+
import urllib.parse
|
|
9
|
+
import urllib.request
|
|
10
|
+
from http import HTTPStatus
|
|
11
|
+
|
|
12
|
+
from spanport._constants import (
|
|
13
|
+
ALLOWED_URL_SCHEMES,
|
|
14
|
+
AUTHORIZATION_HEADER,
|
|
15
|
+
BEARER_PREFIX,
|
|
16
|
+
CURRENT_API_KEY_PATH,
|
|
17
|
+
KEY_CHECK_TIMEOUT_SECONDS,
|
|
18
|
+
VISIBLE_KEY_SUFFIX_LENGTH,
|
|
19
|
+
)
|
|
20
|
+
from spanport._sdk_logger import get_sdk_logger
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
def check_data_key(server_url: str, data_key: str) -> bool:
|
|
24
|
+
"""Ask the server whether the data key is valid and log the answer. Never raises.
|
|
25
|
+
|
|
26
|
+
Args:
|
|
27
|
+
server_url: Base URL of the Spanport server, e.g. "https://spanport.example.com".
|
|
28
|
+
data_key: The raw data key (sp_ingest_...). Only its last characters are ever logged.
|
|
29
|
+
|
|
30
|
+
Returns:
|
|
31
|
+
True if the server accepted the key; False if it rejected it or could not be asked.
|
|
32
|
+
"""
|
|
33
|
+
sdk_logger = get_sdk_logger()
|
|
34
|
+
key_suffix = data_key[-VISIBLE_KEY_SUFFIX_LENGTH:]
|
|
35
|
+
if urllib.parse.urlsplit(server_url).scheme not in ALLOWED_URL_SCHEMES:
|
|
36
|
+
sdk_logger.warning("server_url must start with http:// or https://; key not checked")
|
|
37
|
+
return False
|
|
38
|
+
request = urllib.request.Request( # noqa: S310 - scheme checked above
|
|
39
|
+
server_url.rstrip("/") + CURRENT_API_KEY_PATH,
|
|
40
|
+
headers={AUTHORIZATION_HEADER: BEARER_PREFIX + data_key},
|
|
41
|
+
)
|
|
42
|
+
try:
|
|
43
|
+
with urllib.request.urlopen(request, timeout=KEY_CHECK_TIMEOUT_SECONDS): # noqa: S310
|
|
44
|
+
sdk_logger.info("data key ...%s accepted", key_suffix)
|
|
45
|
+
return True
|
|
46
|
+
except urllib.error.HTTPError as error:
|
|
47
|
+
# The error holds the open response; its body isn't needed, so release it now.
|
|
48
|
+
error.close()
|
|
49
|
+
if error.code == HTTPStatus.UNAUTHORIZED:
|
|
50
|
+
sdk_logger.error(
|
|
51
|
+
"data key ...%s was rejected by %s; logs will NOT be stored. "
|
|
52
|
+
"Check the key, or create one with create-data-key.",
|
|
53
|
+
key_suffix,
|
|
54
|
+
server_url,
|
|
55
|
+
)
|
|
56
|
+
else:
|
|
57
|
+
sdk_logger.warning("could not check data key ...%s: HTTP %d", key_suffix, error.code)
|
|
58
|
+
return False
|
|
59
|
+
except OSError as error:
|
|
60
|
+
sdk_logger.warning(
|
|
61
|
+
"could not reach %s to check data key ...%s: %s", server_url, key_suffix, error
|
|
62
|
+
)
|
|
63
|
+
return False
|
spanport/_pipeline.py
ADDED
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
"""Builds the OpenTelemetry pipeline: Python logging → batch → OTLP/HTTP → collector."""
|
|
2
|
+
|
|
3
|
+
import logging
|
|
4
|
+
|
|
5
|
+
from opentelemetry.exporter.otlp.proto.http._log_exporter import OTLPLogExporter
|
|
6
|
+
from opentelemetry.instrumentation.logging.handler import LoggingHandler
|
|
7
|
+
from opentelemetry.sdk._logs import LoggerProvider
|
|
8
|
+
from opentelemetry.sdk._logs.export import BatchLogRecordProcessor, LogRecordExporter
|
|
9
|
+
from opentelemetry.sdk.resources import SERVICE_NAME, Resource
|
|
10
|
+
|
|
11
|
+
from spanport._constants import (
|
|
12
|
+
AUTHORIZATION_HEADER,
|
|
13
|
+
BEARER_PREFIX,
|
|
14
|
+
EXPORT_PATH_LOGGER_PREFIXES,
|
|
15
|
+
OTLP_LOGS_PATH,
|
|
16
|
+
)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
def is_app_log(record: logging.LogRecord) -> bool:
|
|
20
|
+
"""False for records from the SDK or its export path, which must never be exported."""
|
|
21
|
+
return not record.name.startswith(EXPORT_PATH_LOGGER_PREFIXES)
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
def build_otlp_exporter(collector_url: str, data_key: str) -> OTLPLogExporter:
|
|
25
|
+
"""Exporter that sends batches to the collector with the data key as a bearer token.
|
|
26
|
+
|
|
27
|
+
Args:
|
|
28
|
+
collector_url: Base URL of the OTel Collector, e.g. "http://localhost:4318".
|
|
29
|
+
data_key: The raw data key.
|
|
30
|
+
|
|
31
|
+
Returns:
|
|
32
|
+
The OTLP/HTTP (protobuf) log exporter.
|
|
33
|
+
"""
|
|
34
|
+
return OTLPLogExporter(
|
|
35
|
+
endpoint=collector_url.rstrip("/") + OTLP_LOGS_PATH,
|
|
36
|
+
headers={AUTHORIZATION_HEADER: BEARER_PREFIX + data_key},
|
|
37
|
+
)
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
def build_logging_handler(
|
|
41
|
+
service: str, exporter: LogRecordExporter
|
|
42
|
+
) -> tuple[LoggingHandler, LoggerProvider]:
|
|
43
|
+
"""Build a logging handler that batches records in the background and hands them to `exporter`.
|
|
44
|
+
|
|
45
|
+
Records written inside an OpenTelemetry span carry that span's trace_id and span_id.
|
|
46
|
+
|
|
47
|
+
Args:
|
|
48
|
+
service: Service name shown in Spanport, e.g. "hr-portal-api".
|
|
49
|
+
exporter: Where batches go; OTLP in real use, in-memory in tests.
|
|
50
|
+
|
|
51
|
+
Returns:
|
|
52
|
+
The handler to attach to a logger, and the provider that must be shut down to flush.
|
|
53
|
+
"""
|
|
54
|
+
logger_provider = LoggerProvider(resource=Resource.create({SERVICE_NAME: service}))
|
|
55
|
+
logger_provider.add_log_record_processor(BatchLogRecordProcessor(exporter))
|
|
56
|
+
logging_handler = LoggingHandler(logger_provider=logger_provider)
|
|
57
|
+
logging_handler.addFilter(is_app_log)
|
|
58
|
+
return logging_handler, logger_provider
|
spanport/_sdk_logger.py
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"""The SDK's own logger: always visible on stderr, never exported, never mixed into app logs."""
|
|
2
|
+
|
|
3
|
+
import logging
|
|
4
|
+
|
|
5
|
+
from spanport._constants import SDK_LOG_FORMAT, SDK_LOGGER_NAME
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
def get_sdk_logger() -> logging.Logger:
|
|
9
|
+
"""Return the "spanport" logger, writing to stderr and not passing records to the root logger.
|
|
10
|
+
|
|
11
|
+
Not propagating keeps these messages out of the export pipeline and out of the app's own log
|
|
12
|
+
files, and the stderr handler keeps them visible even if the app configured no logging.
|
|
13
|
+
"""
|
|
14
|
+
sdk_logger = logging.getLogger(SDK_LOGGER_NAME)
|
|
15
|
+
if not sdk_logger.handlers:
|
|
16
|
+
stderr_handler = logging.StreamHandler()
|
|
17
|
+
stderr_handler.setFormatter(logging.Formatter(SDK_LOG_FORMAT))
|
|
18
|
+
sdk_logger.addHandler(stderr_handler)
|
|
19
|
+
sdk_logger.setLevel(logging.INFO)
|
|
20
|
+
sdk_logger.propagate = False
|
|
21
|
+
return sdk_logger
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: spanport
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Send your Python app's logs to Spanport with two lines of code.
|
|
5
|
+
Keywords: logging,observability,opentelemetry,otlp,spanport
|
|
6
|
+
Author: Nitish Bharadwaj
|
|
7
|
+
Author-email: Nitish Bharadwaj <nitishbharadwaj2002@gmail.com>
|
|
8
|
+
License-Expression: Apache-2.0
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Classifier: Development Status :: 2 - Pre-Alpha
|
|
11
|
+
Classifier: Intended Audience :: Developers
|
|
12
|
+
Classifier: Operating System :: OS Independent
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.14
|
|
17
|
+
Classifier: Topic :: System :: Logging
|
|
18
|
+
Classifier: Topic :: System :: Monitoring
|
|
19
|
+
Requires-Dist: opentelemetry-exporter-otlp-proto-http>=1.45.1,<2
|
|
20
|
+
Requires-Dist: opentelemetry-instrumentation-logging>=0.66b1,<1
|
|
21
|
+
Requires-Dist: opentelemetry-sdk>=1.45.1,<2
|
|
22
|
+
Requires-Python: >=3.12
|
|
23
|
+
Project-URL: Homepage, https://github.com/span-port/spanport
|
|
24
|
+
Project-URL: Source, https://github.com/span-port/spanport
|
|
25
|
+
Project-URL: Issues, https://github.com/span-port/spanport/issues
|
|
26
|
+
Description-Content-Type: text/markdown
|
|
27
|
+
|
|
28
|
+
# spanport (Python SDK)
|
|
29
|
+
|
|
30
|
+
Send your Python app's logs to Spanport. Keep logging the way you already do.
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
pip install spanport
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
```python
|
|
37
|
+
import logging
|
|
38
|
+
import spanport
|
|
39
|
+
|
|
40
|
+
spanport.init(
|
|
41
|
+
data_key="sp_ingest_...", # from: python -m spanport_server.cli create-data-key
|
|
42
|
+
service="hr-portal-api",
|
|
43
|
+
collector_url="http://spanport-collector:4318", # default http://localhost:4318
|
|
44
|
+
server_url="http://spanport-server:8000", # default http://localhost:8000
|
|
45
|
+
)
|
|
46
|
+
|
|
47
|
+
logging.getLogger(__name__).error("Payment failed for order 1042")
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
- **Every `logging` call is sent**, at the level your app already logs at (the root logger's level).
|
|
51
|
+
- **Logs are sent in the background**, in batches every few seconds. `spanport.shutdown()` sends what is left; it also runs on normal exit.
|
|
52
|
+
- **Logs inside an OpenTelemetry span** carry that span's `trace_id` and `span_id`, so they show up with the request.
|
|
53
|
+
- **Wrong key?** At start-up the SDK asks the server once whether the key is valid and prints a clear error on stderr if not. Pass `check_key=False` if the app cannot reach the server.
|
|
54
|
+
- **It never breaks your app.** `init()` never raises; problems are printed on stderr as `spanport: ...` and the app carries on.
|
|
55
|
+
|
|
56
|
+
Python 3.12 or newer.
|
|
57
|
+
|
|
58
|
+
## Development
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
uv sync
|
|
62
|
+
uv run pytest
|
|
63
|
+
uv run ruff check . && uv run ruff format --check .
|
|
64
|
+
uv run mypy src tests
|
|
65
|
+
```
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
spanport/__init__.py,sha256=GB3HmmXx4EIAu5arxtM-rHYcSy0JsYMGkVlG--wopDg,3888
|
|
2
|
+
spanport/_constants.py,sha256=2sdmIhThljIWQQVGZIy0bn9ZZy01sazUbiyeOQ-1VbE,827
|
|
3
|
+
spanport/_key_check.py,sha256=8cDxYLtljHXtJetgx7lKcCJmq4Yi8CD-V88_BBE2oms,2447
|
|
4
|
+
spanport/_pipeline.py,sha256=4nPsucccX3L3y1-ns1k_90SLAxKNzqbm6OrRfUU0eus,2248
|
|
5
|
+
spanport/_sdk_logger.py,sha256=_MJe0PMMaFyQNY7DZ_UZFFn1-LYJHTB9Ox7GpfeBmHc,868
|
|
6
|
+
spanport-0.1.0.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
|
|
7
|
+
spanport-0.1.0.dist-info/WHEEL,sha256=9IUYslYuG_asT4WlWvfk_K76nveuLvSTKDoLeL0cV-Q,80
|
|
8
|
+
spanport-0.1.0.dist-info/METADATA,sha256=smUjLx95waWGNoIB213sRMIsj4cfwDmpGV2CzTl5clo,2567
|
|
9
|
+
spanport-0.1.0.dist-info/RECORD,,
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|