Andreas/LibreChat
1
0
Fork 0
mirror of https://github.com/danny-avila/LibreChat.git synced 2026-01-22 02:06:12 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

refactor(api): Central Logging 📜 (#1348)

Browse source 
* WIP: initial logging changes
add several transports in ~/config/winston
omit messages in logs, truncate long strings
add short blurb in dotenv for debug logging
GoogleClient: using logger
OpenAIClient: using logger, handleOpenAIErrors
Adding typedef for payload message
bumped winston and using winston-daily-rotate-file
moved config for server paths to ~/config dir
Added `DEBUG_LOGGING=true` to .env.example

* WIP: Refactor logging statements in code

* WIP: Refactor logging statements and import configurations

* WIP: Refactor logging statements and import configurations

* refactor: broadcast Redis initialization message with `info` not `debug`

* refactor: complete Refactor logging statements and import configurations

* chore: delete unused tools

* fix: circular dependencies due to accessing logger

* refactor(handleText): handle booleans and write tests

* refactor: redact sensitive values, better formatting

* chore: improve log formatting, avoid passing strings to 2nd arg

* fix(ci): fix jest tests due to logger changes

* refactor(getAvailablePluginsController): cache plugins as they are static and avoids async addOpenAPISpecs call every time

* chore: update docs

* chore: update docs

* chore: create separate meiliSync logger, clean up logs to avoid being unnecessarily verbose

* chore: spread objects where they are commonly logged to allow string truncation

* chore: improve error log formatting
This commit is contained in:
Danny Avila 2023-12-14 07:49:27 -05:00 • committed by GitHub
parent 49571ac635
commit ea1dd59ef4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
115 changed files with 1271 additions and 1001 deletions
Download patch file Download diff file Expand all files Collapse all files

5
api/app/clients/tools/structured/AzureAISearch.js
View file

@ -1,6 +1,7 @@
const { StructuredTool } = require('langchain/tools');
const { z } = require('zod');
const { StructuredTool } = require('langchain/tools');
const { SearchClient, AzureKeyCredential } = require('@azure/search-documents');
const { logger } = require('~/config');
class AzureAISearch extends StructuredTool {
// Constants for default values
@ -94,7 +95,7 @@ class AzureAISearch extends StructuredTool {
}
return JSON.stringify(resultDocuments);
} catch (error) {
console.error(`Azure AI Search request failed: ${error.message}`);
logger.error('Azure AI Search request failed', error);
return 'There was an error with Azure AI Search.';
}
}

4
api/app/clients/tools/structured/CodeSherpa.js
View file

@ -28,14 +28,14 @@ class RunCode extends StructuredTool {
}
async _call({ code, language = 'python' }) {
// console.log('<--------------- Running Code --------------->', { code, language });
// logger.debug('<--------------- Running Code --------------->', { code, language });
const response = await axios({
url: `${this.url}/repl`,
method: 'post',
headers: this.headers,
data: { code, language },
});
// console.log('<--------------- Sucessfully ran Code --------------->', response.data);
// logger.debug('<--------------- Sucessfully ran Code --------------->', response.data);
return response.data.result;
}
}

4
api/app/clients/tools/structured/CodeSherpaTools.js
View file

@ -42,14 +42,14 @@ class RunCode extends StructuredTool {
}
async _call({ code, language = 'python' }) {
// console.log('<--------------- Running Code --------------->', { code, language });
// logger.debug('<--------------- Running Code --------------->', { code, language });
const response = await axios({
url: `${this.url}/repl`,
method: 'post',
headers: this.headers,
data: { code, language },
});
// console.log('<--------------- Sucessfully ran Code --------------->', response.data);
// logger.debug('<--------------- Sucessfully ran Code --------------->', response.data);
return response.data.result;
}
}

13
api/app/clients/tools/structured/DALLE3.js
View file

@ -7,7 +7,9 @@ const OpenAI = require('openai');
const { Tool } = require('langchain/tools');
const { HttpsProxyAgent } = require('https-proxy-agent');
const saveImageFromUrl = require('../saveImageFromUrl');
const extractBaseURL = require('../../../../utils/extractBaseURL');
const extractBaseURL = require('~/utils/extractBaseURL');
const { logger } = require('~/config');
const { DALLE3_SYSTEM_PROMPT, DALLE_REVERSE_PROXY, PROXY } = process.env;
class DALLE3 extends Tool {
constructor(fields = {}) {
@ -126,9 +128,12 @@ Error Message: ${error.message}`;
if (match) {
imageName = match[0];
console.log(imageName); // Output: img-lgCf7ppcbhqQrz6a5ear6FOb.png
logger.debug('[DALL-E-3]', { imageName }); // Output: img-lgCf7ppcbhqQrz6a5ear6FOb.png
} else {
console.log('No image name found in the string.');
logger.debug('[DALL-E-3] No image name found in the string.', {
theImageUrl,
data: resp.data[0],
});
}
this.outputPath = path.resolve(
@ -154,7 +159,7 @@ Error Message: ${error.message}`;
await saveImageFromUrl(theImageUrl, this.outputPath, imageName);
this.result = this.getMarkdownImageUrl(imageName);
} catch (error) {
console.error('Error while saving the image:', error);
logger.error('Error while saving the image:', error);
this.result = theImageUrl;
}

23
api/app/clients/tools/structured/E2BTools.js
View file

@ -1,9 +1,10 @@
const { z } = require('zod');
const axios = require('axios');
const { StructuredTool } = require('langchain/tools');
const { PromptTemplate } = require('langchain/prompts');
const { createExtractionChainFromZod } = require('./extractionChain');
// const { ChatOpenAI } = require('langchain/chat_models/openai');
const axios = require('axios');
const { z } = require('zod');
const { createExtractionChainFromZod } = require('./extractionChain');
const { logger } = require('~/config');
const envs = ['Nodejs', 'Go', 'Bash', 'Rust', 'Python3', 'PHP', 'Java', 'Perl', 'DotNET'];
const env = z.enum(envs);
@ -34,8 +35,8 @@ async function extractEnvFromCode(code, model) {
// const chatModel = new ChatOpenAI({ openAIApiKey, modelName: 'gpt-4-0613', temperature: 0 });
const chain = createExtractionChainFromZod(zodSchema, model, { prompt, verbose: true });
const result = await chain.run(code);
console.log('<--------------- extractEnvFromCode --------------->');
console.log(result);
logger.debug('<--------------- extractEnvFromCode --------------->');
logger.debug(result);
return result.env;
}
@ -69,7 +70,7 @@ class RunCommand extends StructuredTool {
}
async _call(data) {
console.log(`<--------------- Running ${data} --------------->`);
logger.debug(`<--------------- Running ${data} --------------->`);
const response = await axios({
url: `${this.url}/commands`,
method: 'post',
@ -96,7 +97,7 @@ class ReadFile extends StructuredTool {
}
async _call(data) {
console.log(`<--------------- Reading ${data} --------------->`);
logger.debug(`<--------------- Reading ${data} --------------->`);
const response = await axios.get(`${this.url}/files`, { params: data, headers: this.headers });
return response.data;
}
@ -121,12 +122,12 @@ class WriteFile extends StructuredTool {
async _call(data) {
let { env, path, content } = data;
console.log(`<--------------- environment ${env} typeof ${typeof env}--------------->`);
logger.debug(`<--------------- environment ${env} typeof ${typeof env}--------------->`);
if (env && !envs.includes(env)) {
console.log(`<--------------- Invalid environment ${env} --------------->`);
logger.debug(`<--------------- Invalid environment ${env} --------------->`);
env = await extractEnvFromCode(content, this.model);
} else if (!env) {
console.log('<--------------- Undefined environment --------------->');
logger.debug('<--------------- Undefined environment --------------->');
env = await extractEnvFromCode(content, this.model);
}
@ -139,7 +140,7 @@ class WriteFile extends StructuredTool {
content,
},
};
console.log('Writing to file', JSON.stringify(payload));
logger.debug('Writing to file', JSON.stringify(payload));
await axios({
url: `${this.url}/files`,

5
api/app/clients/tools/structured/StableDiffusion.js
View file

@ -1,10 +1,11 @@
// Generates image using stable diffusion webui's api (automatic1111)
const fs = require('fs');
const { StructuredTool } = require('langchain/tools');
const { z } = require('zod');
const path = require('path');
const axios = require('axios');
const sharp = require('sharp');
const { StructuredTool } = require('langchain/tools');
const { logger } = require('~/config');
class StableDiffusionAPI extends StructuredTool {
constructor(fields) {
@ -107,7 +108,7 @@ class StableDiffusionAPI extends StructuredTool {
.toFile(this.outputPath + '/' + imageName);
this.result = this.getMarkdownImageUrl(imageName);
} catch (error) {
console.error('Error while saving the image:', error);
logger.error('[StableDiffusion] Error while saving the image:', error);
// this.result = theImageUrl;
}

10
api/app/clients/tools/structured/Wolfram.js
View file

@ -1,7 +1,8 @@
/* eslint-disable no-useless-escape */
const axios = require('axios');
const { StructuredTool } = require('langchain/tools');
const { z } = require('zod');
const { StructuredTool } = require('langchain/tools');
const { logger } = require('~/config');
class WolframAlphaAPI extends StructuredTool {
constructor(fields) {
@ -47,7 +48,7 @@ class WolframAlphaAPI extends StructuredTool {
const response = await axios.get(url, { responseType: 'text' });
return response.data;
} catch (error) {
console.error(`Error fetching raw text: ${error}`);
logger.error('[WolframAlphaAPI] Error fetching raw text:', error);
throw error;
}
}
@ -78,11 +79,10 @@ class WolframAlphaAPI extends StructuredTool {
return response;
} catch (error) {
if (error.response && error.response.data) {
console.log('Error data:', error.response.data);
logger.error('[WolframAlphaAPI] Error data:', error);
return error.response.data;
} else {
console.log('Error querying Wolfram Alpha', error.message);
// throw error;
logger.error('[WolframAlphaAPI] Error querying Wolfram Alpha', error);
return 'There was an error querying Wolfram Alpha.';
}
}

11
api/app/clients/tools/structured/specs/DALLE3.spec.js
View file

@ -3,6 +3,7 @@ const path = require('path');
const OpenAI = require('openai');
const DALLE3 = require('../DALLE3');
const saveImageFromUrl = require('../../saveImageFromUrl');
const { logger } = require('~/config');
jest.mock('openai');
@ -145,10 +146,13 @@ describe('DALLE3', () => {
},
],
};
console.log = jest.fn(); // Mock console.log
generate.mockResolvedValue(mockResponse);
await dalle._call(mockData);
expect(console.log).toHaveBeenCalledWith('No image name found in the string.');
expect(logger.debug).toHaveBeenCalledWith('[DALL-E-3] No image name found in the string.', {
data: { url: 'http://example.com/invalid-url' },
theImageUrl: 'http://example.com/invalid-url',
});
});
it('should create the directory if it does not exist', async () => {
@ -182,9 +186,8 @@ describe('DALLE3', () => {
const error = new Error('Error while saving the image');
generate.mockResolvedValue(mockResponse);
saveImageFromUrl.mockRejectedValue(error);
console.error = jest.fn(); // Mock console.error
const result = await dalle._call(mockData);
expect(console.error).toHaveBeenCalledWith('Error while saving the image:', error);
expect(logger.error).toHaveBeenCalledWith('Error while saving the image:', error);
expect(result).toBe(mockResponse.data[0].url);
});
});