You've already forked OpenIntegrations
mirror of
https://github.com/Bayselonarrend/OpenIntegrations.git
synced 2026-05-16 09:38:28 +02:00
Vitaly the Alpaca (bot)
88 lines
2.9 KiB
Plaintext
Vendored
88 lines
2.9 KiB
Plaintext
Vendored
---
|
|
sidebar_position: 2
|
|
sidebar_class_name: doc-no-cli
|
|
description: Get log and other functions to work with WebSocket in the Open Integration Package, a free open-source integration library for 1C:Enterprise 8, OneScript and CLI
|
|
keywords: [1C, 1С, 1С:Enterprise, 1С:Enterprise 8.3, API, Integration, Services, Exchange, OneScript, CLI, WebSocket]
|
|
---
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
import Admonition from '@theme/Admonition';
|
|
|
|
# Get log
|
|
Retrieves server log data (with logging to memory enabled)
|
|
|
|
|
|
|
|
<Tabs>
|
|
<TabItem value="params" label="Parameters" default>
|
|
|
|
`Function GetLog(Val AddInObject, Val AsString = False, Val EventCount = 100) Export`
|
|
|
|
| Parameter | CLI option | Type | Required | Description |
|
|
|-|-|-|-|-|
|
|
| AddInObject | - | Arbitrary | ✔ | Server or client component object |
|
|
| AsString | - | Boolean | ✖ | True > returns log as a single string, False > as an array |
|
|
| EventCount | - | Number | ✖ | Number of recent events to retrieve. 0 > no limits |
|
|
|
|
|
|
<div className="return-value-note">
|
|
<div className="return-value-note__title">Returns</div>
|
|
<div className="return-value-note__value">
|
|
String, Map Of KeyAndValue - Log as a string or a map with the full execution result
|
|
</div>
|
|
</div>
|
|
|
|
</TabItem>
|
|
<TabItem value="extended" label={<span>Advanced call{' '}<a href="/docs/Start/Advanced-call" target="_blank" rel="noreferrer" title="About advanced call" onClick={(e) => e.stopPropagation()}>?</a></span>}>
|
|
|
|
*This method has no additional advanced call parameters.*
|
|
|
|
|
|
</TabItem>
|
|
</Tabs>
|
|
|
|
|
|
<Admonition type="caution" title="Caution" className="nocli-admonition">
|
|
<div className="addin">
|
|
<strong>NOCLI:</strong> this method is not available in CLI version
|
|
</div>
|
|
</Admonition>
|
|
|
|
|
|
```bsl title="1C:Enterprise/OneScript code example"
|
|
// Server start
|
|
LaunchPort = 9894;
|
|
LogFile = GetTempFileName("txt");
|
|
LoggingSettings = OPI_WebSocket.GetLoggingSettings(True, 100, LogFile);
|
|
ServerObject = OPI_WebSocket.StartServer(LaunchPort, , LoggingSettings);
|
|
|
|
// Client connect to server
|
|
ConnectionAddress = "ws://127.0.0.1:9894";
|
|
ClientObject = OPI_WebSocket.CreateConnection(ConnectionAddress);
|
|
If Not OPI_WebSocket.IsClientObject(ClientObject) Then
|
|
Raise OPI_Tools.JSONString(ClientObject);
|
|
EndIf;
|
|
|
|
// Server log retrieval
|
|
Result = OPI_WebSocket.GetLog(ServerObject);
|
|
```
|
|
|
|
|
|
|
|
|
|
```json title="Result"
|
|
{
|
|
"logs": [
|
|
"[2026-05-02 11:07:56.936] Starting WebSocket server on port 9894 with config: WebSocketServerConfig ...",
|
|
"[2026-05-02 11:07:56.937] Adding WebSocket route: /",
|
|
"[2026-05-02 11:07:56.937] WebSocket server listening on 0.0.0.0:9894",
|
|
"[2026-05-02 11:07:56.937] Connection added: 3bba032b-11bb-42b2-852c-7d6c205c4bfe",
|
|
"[2026-05-02 11:07:56.937] WebSocket connected: 3bba032b-11bb-42b2-852c-7d6c205c4bfe"
|
|
],
|
|
"result": true,
|
|
"returned": 5,
|
|
"total": 5
|
|
}
|
|
```
|