logdetective 2.4.1__py3-none-any.whl → 2.6.0__py3-none-any.whl

logdetective/server/templates/gitlab_full_comment.md.j2

@@ -57,15 +57,15 @@ Please know that the explanation was provided by AI and may be incorrect.
         </li>
     </ul>
 </details>
----
-This comment was created by [Log Detective][log-detective].
+
+<hr>
+
+This comment was created by <a href="https://logdetective.com">Log Detective</a>.
 Was the provided feedback accurate and helpful?
 <br>
 Please vote with :thumbsup:
 or :thumbsdown: to help us improve.
 <br>
-<i>If this Log Detective report contains harmful content, please use the
-    [Gitlab reporting feature for harmful content](https://docs.gitlab.com/user/report_abuse/)
-and contact the [Log Detective developers](https://github.com/fedora-copr/logdetective/issues).</i>
-[log-detective]: https://log-detective.com/
-[contact]: https://github.com/fedora-copr
+<i>If this Log Detective report contains harmful content,
+please use the <a href="https://docs.gitlab.com/user/report_abuse/">Gitlab reporting feature for harmful content</a>
+and contact the <a href="https://github.com/fedora-copr/logdetective/issues">Log Detective developers</a>.</i>

logdetective/server/templates/gitlab_short_comment.md.j2

@@ -46,15 +46,15 @@ Please know that the explanation was provided by AI and may be incorrect.
         </li>
     </ul>
 </details>
----
-This comment was created by [Log Detective][log-detective].
+
+<hr>
+
+This comment was created by <a href="https://logdetective.com">Log Detective</a>.
 Was the provided feedback accurate and helpful?
 <br>
 Please vote with :thumbsup:
 or :thumbsdown: to help us improve.
 <br>
-<i>If this Log Detective report contains harmful content, please use the
-    [Gitlab reporting feature for harmful content](https://docs.gitlab.com/user/report_abuse/)
-and contact the [Log Detective developers](https://github.com/fedora-copr/logdetective/issues).</i>
-[log-detective]: https://log-detective.com/
-[contact]: https://github.com/fedora-copr
+<i>If this Log Detective report contains harmful content,
+please use the <a href="https://docs.gitlab.com/user/report_abuse/">Gitlab reporting feature for harmful content</a>
+and contact the <a href="https://github.com/fedora-copr/logdetective/issues">Log Detective developers</a>.</i>

logdetective/server/utils.py

@@ -1,7 +1,9 @@
 from typing import List
+from importlib.metadata import version
 
 import aiohttp
 from fastapi import HTTPException
+from fastapi.responses import Response as BasicResponse
 
 from logdetective.constants import SNIPPET_DELIMITER
 from logdetective.server.config import LOG
@@ -102,3 +104,8 @@ def construct_final_prompt(formatted_snippets: str, prompt_template: str) -> str
 
     final_prompt = prompt_template.format(formatted_snippets)
     return final_prompt
+
+
+def get_version() -> BasicResponse:
+    """Obtain the version number using importlib"""
+    return BasicResponse(content=version('logdetective'))

logdetective/utils.py

@@ -16,54 +16,61 @@ from logdetective.remote_log import RemoteLog
 LOG = logging.getLogger("logdetective")
 
 
-def chunk_continues(text: str, index: int) -> bool:
+def new_message(text: str) -> bool:
     """Set of heuristics for determining whether or not
     does the current chunk of log text continue on next line.
 
     Following rules are checked, in order:
-    * is the next character is whitespace
-    * is the previous character backslash '\\'
-    * is the previous character colon ':'
-
+    * is the first character is whitespace
+    * is the first character backslash '|'
     """
     conditionals = [
-        lambda i, string: string[i + 1].isspace(),
-        lambda i, string: string[i - 1] == "\\",
-        lambda i, string: string[i - 1] == ":",
+        lambda string: string[0].isspace(),
+        lambda string: string[0] == "|",
     ]
 
     for c in conditionals:
-        y = c(index, text)
+        y = c(text)
         if y:
-            return True
+            return False
 
-    return False
+    return True
 
 
 def get_chunks(
-    text: str, max_len: int = 2000
+    text: str, max_chunk_len: int = 2000
 ) -> Generator[Tuple[int, str], None, None]:
     """Split log into chunks according to heuristic
     based on whitespace and backslash presence.
     """
-    text_len = len(text)
-    i = 0
+    lines = text.splitlines()
+
+    # Chunk we will be yielding
     chunk = ""
-    # Keep track of the original and next line number
-    # every `\n` hit increases the next_line_number by one.
-    original_line_number = 0
-    next_line_number = 0
-    while i < text_len:
-        chunk += text[i]
-        if text[i] == "\n":
-            next_line_number += 1
-            if i + 1 < text_len and chunk_continues(text, i) and i + 1 < max_len:
-                i += 1
-                continue
-            yield (original_line_number, chunk)
-            original_line_number = next_line_number + 1
-            chunk = ""
-        i += 1
+    # Number of line where the message started
+    original_line = 0
+    for i, line in enumerate(lines):
+        if len(line) == 0:
+            continue
+        if new_message(line):
+            # Yield chunk if we have it
+            if len(chunk) > 0:
+                yield (original_line, chunk)
+            original_line = i
+            chunk = line
+        else:
+            chunk += "\n" + line
+        if len(chunk) > max_chunk_len:
+            # If the chunk is too long, keep splitting into smaller chunks
+            # until we reach manageable size
+            while len(chunk) > max_chunk_len:
+                remainder = chunk[max_chunk_len:]
+                chunk = chunk[:max_chunk_len]
+                yield (original_line, chunk)
+                chunk = remainder
+
+    # if we still have some text left over
+    yield (original_line, chunk)
 
 
 def initialize_model(

{logdetective-2.4.1.dist-info → logdetective-2.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: logdetective
-Version: 2.4.1
+Version: 2.6.0
 Summary: Log using LLM AI to search for build/test failures and provide ideas for fixing these.
 License: Apache-2.0
 License-File: LICENSE
@@ -27,6 +27,8 @@ Requires-Dist: aiohttp (>=3.7.4,<4.0.0)
 Requires-Dist: aiolimiter (>=1.0.0,<2.0.0) ; extra == "server"
 Requires-Dist: aioresponses (>=0.7.8,<0.8.0) ; extra == "testing"
 Requires-Dist: alembic (>=1.13.3,<2.0.0) ; extra == "server" or extra == "server-testing"
+Requires-Dist: asciidoc[testing] (>=10.2.1,<11.0.0) ; extra == "testing"
+Requires-Dist: asyncpg (>=0.30.0,<0.31.0) ; extra == "server" or extra == "server-testing"
 Requires-Dist: backoff (==2.2.1) ; extra == "server" or extra == "server-testing"
 Requires-Dist: drain3 (>=0.9.11,<0.10.0)
 Requires-Dist: fastapi (>=0.111.1,<1.0.0) ; extra == "server" or extra == "server-testing"
@@ -37,11 +39,10 @@ Requires-Dist: llama-cpp-python (>0.2.56,!=0.2.86,<1.0.0)
 Requires-Dist: matplotlib (>=3.8.4,<4.0.0) ; extra == "server" or extra == "server-testing"
 Requires-Dist: numpy (>=1.26.0)
 Requires-Dist: openai (>=1.82.1,<2.0.0) ; extra == "server" or extra == "server-testing"
-Requires-Dist: psycopg2 (>=2.9.9,<3.0.0) ; extra == "server"
-Requires-Dist: psycopg2-binary (>=2.9.9,<3.0.0) ; extra == "server-testing"
 Requires-Dist: pydantic (>=2.8.2,<3.0.0)
 Requires-Dist: pytest (>=8.4.1,<9.0.0) ; extra == "testing"
 Requires-Dist: pytest-asyncio (>=1.1.0,<2.0.0) ; extra == "testing"
+Requires-Dist: pytest-cov[testing] (>=7.0.0,<8.0.0) ; extra == "testing"
 Requires-Dist: pytest-mock (>=3.14.1,<4.0.0) ; extra == "server-testing"
 Requires-Dist: python-gitlab (>=4.4.0)
 Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
@@ -127,6 +128,20 @@ Note that streaming with some models (notably Meta-Llama-3) is broken and can be
 
     logdetective https://example.com/logs.txt --model QuantFactory/Meta-Llama-3-8B-Instruct-GGUF --filename_suffix Q5_K_M.gguf --no-stream
 
+Choice of LLM
+-------------
+
+While Log Detective is compatible with a wide range of LLMs, it does require an instruction tuned model to function properly.
+
+Whether or not the model has been trained to work with instructions can be determined by examining the model card, or simply by checking if it has `instruct` in its name.
+
+When deployed as a server, Log Detective uses `/chat/completions` API as defined by OpenAI. The API must support both `system` and `user` roles, in order to properly work with a system prompt.
+
+Configuration fields `system_role` and `user_role` can be used to set role names for APIs with non-standard roles.
+
+> **Note:**
+> In cases when no system role is available, it is possible to set both fields to the same value. This will concatenate system and standard prompt.
+> This may have negative impact coherence of response.
 
 Real Example
 ------------

{logdetective-2.4.1.dist-info → logdetective-2.6.0.dist-info}/RECORD

@@ -4,37 +4,37 @@ logdetective/drain3.ini,sha256=ni91eCT1TwTznZwcqWoOVMQcGEnWhEDNCoTPF7cfGfY,1360
 logdetective/extractors.py,sha256=vT-je4NkDgSj9rRtSeLpqBU52gIUnnVgJPHFbVihpCw,5993
 logdetective/logdetective.py,sha256=Ck7TL3YvdQG8zniudM8bM51LfTyVW6Ea3BarTjzjWHo,6606
 logdetective/models.py,sha256=uczmQtWFgSp_ZGssngdTM4qzPF1o64dCy0469GoSbjQ,2937
-logdetective/prompts-summary-first.yml,sha256=3Zfp4NNOfaFYq5xBlBjeQa5PdjYfS4v17OtJqQ-DRpU,821
+logdetective/prompts-summary-first.yml,sha256=kmyMFQmqFXpojkz7p3CyCWCPxMpFLpfDdMGisB4YwL0,808
 logdetective/prompts-summary-only.yml,sha256=8U9AMJV8ePW-0CoXOXlQoO92DAJDeutIT8ntSkkm6W0,470
-logdetective/prompts.yml,sha256=Mq8RdWgJxxhrQYgammojJkXULJNpzSLU0N_BryOxKgc,3906
+logdetective/prompts.yml,sha256=i3z6Jcb4ScVi7LsxOpDlKiXrcvql3qO_JnLzkAKMn1c,3870
 logdetective/remote_log.py,sha256=28QvdQiy7RBnd86EKCq_A75P21gSNlCbgxJe5XAe9MA,2258
 logdetective/server/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 logdetective/server/compressors.py,sha256=qzrT-BPSksXY6F2L6ger04GGrgdBsGOfK2YuCFRs0Q4,5427
 logdetective/server/config.py,sha256=cKUmNCJyNyEid0bPTiUjr8CQuBYBab5bC79Axk2h0z8,2525
 logdetective/server/database/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-logdetective/server/database/base.py,sha256=1mcjEbhwLl4RalvT3oy6XVctjJoWIW3H9aI_sMWJBK8,1728
-logdetective/server/database/models/__init__.py,sha256=GQ_4vC_jahwFrqhF4UUKLRo86_ulq1uSBAF3Je31DyA,878
+logdetective/server/database/base.py,sha256=HSV2tgye7iYTDzJD1Q5X7_nlLuTMIFP-hRVQMYxngHQ,2073
+logdetective/server/database/models/__init__.py,sha256=zoZMCt1_7tewDa6eEIIX_xrdN-tLegSiPNg5NiYaV3o,850
 logdetective/server/database/models/exceptions.py,sha256=AXQPZRgt-r2vboxP9SGYelngP6YIFpHlwELKcZ1FD3Y,384
-logdetective/server/database/models/koji.py,sha256=vZN585FvOHM4z5o3oBBQsxWWJER1_giOMtZZPiU4q3w,5457
-logdetective/server/database/models/merge_request_jobs.py,sha256=q4reSC7YnEfWBPpV-qNt5nvuq0drntisHnKkFOlQW0o,18614
-logdetective/server/database/models/metrics.py,sha256=_UCaizcl9w4iX54EWvk5VvXeLcg2UfnQgXg4br3OLko,14214
-logdetective/server/emoji.py,sha256=hV4O0yfL0l1a3kWLImvBsY4AJQauKs7okYOGBEtYVz0,4795
+logdetective/server/database/models/koji.py,sha256=3soiJQ3L-H09cVO-BeRDEcP-HrSa-Z6qp3kwePUZsbo,6216
+logdetective/server/database/models/merge_request_jobs.py,sha256=MxiAVKQIsQMbFylBsmYBmVXYvid-4_5mwwXLfWdp6_w,19965
+logdetective/server/database/models/metrics.py,sha256=zzTRo67qwLyDj1GKbclZm1UXt1nNU-G662-y5XyGshE,15458
+logdetective/server/emoji.py,sha256=CoaAiZA_JgtUJe41YOsQRqd_QpgVeQ8szJt_bQ3d_JM,4837
 logdetective/server/exceptions.py,sha256=piV7wVKc-rw_pHrThbZbUjtmjuO5qUbjVNFwjdfcP3Q,864
-logdetective/server/gitlab.py,sha256=hPQICeYK1B_1BS56GIExQgEhcdS5Y6IgBCkk-eXtnDY,16708
+logdetective/server/gitlab.py,sha256=putpnf8PfGsCZJsqWZA1rMovRGnyagoQmgpKLqtA-aQ,16743
 logdetective/server/koji.py,sha256=LG1pRiKUFvYFRKzgQoUG3pUHfcEwMoaMNjUSMKw_pBA,5640
 logdetective/server/llm.py,sha256=bmA6LsV80OdO60q4WLoKuehuVDEYq-HhBAYcZeLfrv8,10150
-logdetective/server/metric.py,sha256=QrrX1FmMa7sc57av0P9UFOiCIFYVLs1opOWV3ObYo0s,4086
+logdetective/server/metric.py,sha256=-gqdd6LBUs_K6Sk30TZ7FJYE7Htp8d-uhVY5NwYgD3g,4186
 logdetective/server/models.py,sha256=BoiiUYI6BcVDOqtIcUgNRsCyjcWNCKyEfVtYOLYgr1Y,20929
-logdetective/server/plot.py,sha256=C98U9prGoPkp8_t4v2dovdZuwOhSbxXSeB_K9Q2r3NE,14607
-logdetective/server/server.py,sha256=s1QtD6FYsQX7BaVi783v7sqCEk4ccqlBJHFKUQlGgWM,24684
+logdetective/server/plot.py,sha256=lFKOTXlLJ3aZtZGYXceA4OqUt1z18BpLITTI39fOMx4,14685
+logdetective/server/server.py,sha256=Qx8mqkrRq-nlOnmOmICbaXxUWq2J60K4dHKiJtQJuE0,24938
 logdetective/server/templates/base_response.html.j2,sha256=BJGGV_Xb0Lnue8kq32oG9lI5CQDf9vce7HMYsP-Pvb4,2040
-logdetective/server/templates/gitlab_full_comment.md.j2,sha256=eNX_ZkAAVV7nNfKe02g_1-GgbiSqim0JH4aF3anzmxE,2186
-logdetective/server/templates/gitlab_short_comment.md.j2,sha256=UpQxIgOuOO8BBF__kzFl0XlCuYmcyfN2yMz6vd4PQ2Q,2000
-logdetective/server/utils.py,sha256=7ub-Nz7LUP_idwi2_nEC4FBuY9otSBUVy9nw86-sjYc,3861
+logdetective/server/templates/gitlab_full_comment.md.j2,sha256=hSWEj_a7KZpzfbgoPhWA9KBwa25daDCb6S3cuBqclss,2143
+logdetective/server/templates/gitlab_short_comment.md.j2,sha256=d396HR2DJuS8XLu2FNgVAg1CrOW8_LySQX2f6opOjp8,1957
+logdetective/server/utils.py,sha256=KiyzzUIVssBc61LhGS0QNC5EY29In3NsG9j58ZRtoNI,4104
 logdetective/skip_snippets.yml,sha256=reGlhPPCo06nNUJWiC2LY-OJOoPdcyOB7QBTSMeh0eg,487
-logdetective/utils.py,sha256=9EyHKGNxtS1ObSepL-T3M43rKIxQJkFDA5yllLbS5Bs,9178
-logdetective-2.4.1.dist-info/METADATA,sha256=wBT_T5szJE3Xnn76UvC4drCacVhgCaBQ0QZkrBbpjnk,21645
-logdetective-2.4.1.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-logdetective-2.4.1.dist-info/entry_points.txt,sha256=3K_vXja6PmcA8sNdUi63WdImeiNhVZcEGPTaoJmltfA,63
-logdetective-2.4.1.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-logdetective-2.4.1.dist-info/RECORD,,
+logdetective/utils.py,sha256=4B9wwaM4tyxLFtRnnTRDcGULJDonp6VoUS8HvUpIeSI,9388
+logdetective-2.6.0.dist-info/METADATA,sha256=hLRUiBvOeyWn6t9qkRVEx3nLuNmysSoReXL6aFBECsg,22598
+logdetective-2.6.0.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+logdetective-2.6.0.dist-info/entry_points.txt,sha256=3K_vXja6PmcA8sNdUi63WdImeiNhVZcEGPTaoJmltfA,63
+logdetective-2.6.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+logdetective-2.6.0.dist-info/RECORD,,